From 2ca732c03ed09b80c47852acf8150378ae30f0a3 Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Mon, 9 Mar 2026 19:48:02 -0400 Subject: [PATCH 1/7] Remove metafield references from examples --- .../default.example.tsx | 14 ++++++++------ .../default.example.tsx | 14 ++++++++------ 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx index 87e8227e60..c59c15e4f2 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx @@ -59,12 +59,14 @@ function Extension() { async function onCheckboxChange(isChecked) { setChecked(isChecked); const result = - await shopify.applyMetafieldsChange({ - type: 'updateMetafield', - namespace: metafieldNamespace, - key: metafieldKey, - value: isChecked ? 'yes' : 'no', - valueType: 'string', + await shopify.applyMetafieldChange({ + type: 'updateCartMetafield', + metafield: { + namespace: metafieldNamespace, + key: metafieldKey, + value: isChecked ? 'yes' : 'no', + type: 'single_line_text_field', + }, }); console.log( 'applyMetafieldsChange result', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx index 87e8227e60..c59c15e4f2 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx @@ -59,12 +59,14 @@ function Extension() { async function onCheckboxChange(isChecked) { setChecked(isChecked); const result = - await shopify.applyMetafieldsChange({ - type: 'updateMetafield', - namespace: metafieldNamespace, - key: metafieldKey, - value: isChecked ? 'yes' : 'no', - valueType: 'string', + await shopify.applyMetafieldChange({ + type: 'updateCartMetafield', + metafield: { + namespace: metafieldNamespace, + key: metafieldKey, + value: isChecked ? 'yes' : 'no', + type: 'single_line_text_field', + }, }); console.log( 'applyMetafieldsChange result', From 9bbc0b41845d00add46d98dc0cf900c6b4186d3e Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Mon, 9 Mar 2026 19:52:21 -0400 Subject: [PATCH 2/7] Update API version in example TOML files --- .../checkout/reference/examples/extension-targets.example.toml | 2 +- .../surfaces/checkout/reference/examples/settings.example.toml | 2 +- .../staticPages/examples/configuration/default.example.toml | 2 +- .../staticPages/examples/configuration/extended.example.toml | 2 +- .../staticPages/examples/configuration/settings.example.toml | 2 +- .../examples/upgrading-to-2025-10/shopify.extension-new.toml | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml index 3196f64934..1e2675f28f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] name = "My checkout extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml index caf0bd31fb..4993e49484 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] name = "My checkout extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml index 5a040e5217..43d68789d0 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] type = "ui_extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml index 0a5f5125be..d85d4fad6a 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml @@ -1,4 +1,4 @@ -api_version ="2026-01" +api_version ="2026-04" [[extensions]] type = "ui_extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml index 12e475ad94..cc5ee16226 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] type = "ui_extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml index 59168bb501..d2948f4e6b 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] name = "your-extension" From 76f4c7d102060a33ebca3dc3e1a9c00a90562370 Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Mon, 9 Mar 2026 19:52:29 -0400 Subject: [PATCH 3/7] Update generated files --- .../surfaces/checkout/generated/generated_docs_data.json | 8 ++++---- .../checkout/generated/generated_static_pages.json | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json index 0ee8132ea5..ca2f279110 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json @@ -22837,7 +22837,7 @@ "title": "Define merchant settings", "tabs": [ { - "code": "api_version = \"2026-01\"\n\n[[extensions]]\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\ntype = \"ui_extension\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Checkout.jsx\"\n\n[extensions.settings]\n[[extensions.settings.fields]]\nkey = \"banner_title\"\ntype = \"single_line_text_field\"\nname = \"Banner title\"\ndescription = \"Enter a title for the banner.\"\n[[extensions.settings.fields.validations]]\nname = \"min\"\nvalue = \"5\"\n[[extensions.settings.fields.validations]]\nname = \"max\"\nvalue = \"20\"\n", + "code": "api_version = \"2026-04\"\n\n[[extensions]]\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\ntype = \"ui_extension\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Checkout.jsx\"\n\n[extensions.settings]\n[[extensions.settings.fields]]\nkey = \"banner_title\"\ntype = \"single_line_text_field\"\nname = \"Banner title\"\ndescription = \"Enter a title for the banner.\"\n[[extensions.settings.fields.validations]]\nname = \"min\"\nvalue = \"5\"\n[[extensions.settings.fields.validations]]\nname = \"max\"\nvalue = \"20\"\n", "language": "toml", "title": "shopify.extension.toml" } @@ -155510,7 +155510,7 @@ "title": " purchase.checkout.shipping-option-list.render-after", "tabs": [ { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const metafieldNamespace = 'yourAppNamespace';\n const [checked, setChecked] = useState(false);\n\n // 1. Render a UI\n if (!shopify.target.value) {\n return null;\n }\n\n const {groupType, deliveryGroups} =\n shopify.target.value;\n const metafieldKey =\n groupType === 'oneTimePurchase'\n ? 'isGift-oneTimePurchase'\n : 'isGift-subscription';\n const selectedDeliverySelectionGroup =\n shopify.deliverySelectionGroups.value?.find(\n ({selected}) => selected,\n );\n\n const groupLabel =\n groupType === 'oneTimePurchase'\n ? 'one time purchase'\n : 'subscription';\n\n const title =\n deliveryGroups.length > 1\n ? `Your order contains multiple ${groupLabel} shipments.`\n : `Your order contains one ${groupLabel} shipment.`;\n\n let deliverySelectionGroupInfo = '';\n if (selectedDeliverySelectionGroup) {\n deliverySelectionGroupInfo = ` Items will be delivered with the ${selectedDeliverySelectionGroup.title} delivery selection group.`;\n }\n\n return (\n <s-stack gap=\"base\">\n <s-banner\n tone=\"info\"\n heading={`${title}${deliverySelectionGroupInfo}`}\n />\n <s-checkbox\n onChange={onCheckboxChange}\n checked={checked}\n label={`The ${groupLabel} section contains gifts`}\n />\n </s-stack>\n );\n\n // 2. Call API methods to modify the checkout\n async function onCheckboxChange(isChecked) {\n setChecked(isChecked);\n const result =\n await shopify.applyMetafieldsChange({\n type: 'updateMetafield',\n namespace: metafieldNamespace,\n key: metafieldKey,\n value: isChecked ? 'yes' : 'no',\n valueType: 'string',\n });\n console.log(\n 'applyMetafieldsChange result',\n result,\n );\n }\n}\n", + "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const metafieldNamespace = 'yourAppNamespace';\n const [checked, setChecked] = useState(false);\n\n // 1. Render a UI\n if (!shopify.target.value) {\n return null;\n }\n\n const {groupType, deliveryGroups} =\n shopify.target.value;\n const metafieldKey =\n groupType === 'oneTimePurchase'\n ? 'isGift-oneTimePurchase'\n : 'isGift-subscription';\n const selectedDeliverySelectionGroup =\n shopify.deliverySelectionGroups.value?.find(\n ({selected}) => selected,\n );\n\n const groupLabel =\n groupType === 'oneTimePurchase'\n ? 'one time purchase'\n : 'subscription';\n\n const title =\n deliveryGroups.length > 1\n ? `Your order contains multiple ${groupLabel} shipments.`\n : `Your order contains one ${groupLabel} shipment.`;\n\n let deliverySelectionGroupInfo = '';\n if (selectedDeliverySelectionGroup) {\n deliverySelectionGroupInfo = ` Items will be delivered with the ${selectedDeliverySelectionGroup.title} delivery selection group.`;\n }\n\n return (\n <s-stack gap=\"base\">\n <s-banner\n tone=\"info\"\n heading={`${title}${deliverySelectionGroupInfo}`}\n />\n <s-checkbox\n onChange={onCheckboxChange}\n checked={checked}\n label={`The ${groupLabel} section contains gifts`}\n />\n </s-stack>\n );\n\n // 2. Call API methods to modify the checkout\n async function onCheckboxChange(isChecked) {\n setChecked(isChecked);\n const result =\n await shopify.applyMetafieldChange({\n type: 'updateCartMetafield',\n metafield: {\n namespace: metafieldNamespace,\n key: metafieldKey,\n value: isChecked ? 'yes' : 'no',\n type: 'single_line_text_field',\n },\n });\n console.log(\n 'applyMetafieldsChange result',\n result,\n );\n }\n}\n", "language": "jsx", "title": "Preact" } @@ -162189,7 +162189,7 @@ "title": " purchase.checkout.shipping-option-list.render-before", "tabs": [ { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const metafieldNamespace = 'yourAppNamespace';\n const [checked, setChecked] = useState(false);\n\n // 1. Render a UI\n if (!shopify.target.value) {\n return null;\n }\n\n const {groupType, deliveryGroups} =\n shopify.target.value;\n const metafieldKey =\n groupType === 'oneTimePurchase'\n ? 'isGift-oneTimePurchase'\n : 'isGift-subscription';\n const selectedDeliverySelectionGroup =\n shopify.deliverySelectionGroups.value?.find(\n ({selected}) => selected,\n );\n\n const groupLabel =\n groupType === 'oneTimePurchase'\n ? 'one time purchase'\n : 'subscription';\n\n const title =\n deliveryGroups.length > 1\n ? `Your order contains multiple ${groupLabel} shipments.`\n : `Your order contains one ${groupLabel} shipment.`;\n\n let deliverySelectionGroupInfo = '';\n if (selectedDeliverySelectionGroup) {\n deliverySelectionGroupInfo = ` Items will be delivered with the ${selectedDeliverySelectionGroup.title} delivery selection group.`;\n }\n\n return (\n <s-stack gap=\"base\">\n <s-banner\n tone=\"info\"\n heading={`${title}${deliverySelectionGroupInfo}`}\n />\n <s-checkbox\n onChange={onCheckboxChange}\n checked={checked}\n label={`The ${groupLabel} section contains gifts`}\n />\n </s-stack>\n );\n\n // 2. Call API methods to modify the checkout\n async function onCheckboxChange(isChecked) {\n setChecked(isChecked);\n const result =\n await shopify.applyMetafieldsChange({\n type: 'updateMetafield',\n namespace: metafieldNamespace,\n key: metafieldKey,\n value: isChecked ? 'yes' : 'no',\n valueType: 'string',\n });\n console.log(\n 'applyMetafieldsChange result',\n result,\n );\n }\n}\n", + "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const metafieldNamespace = 'yourAppNamespace';\n const [checked, setChecked] = useState(false);\n\n // 1. Render a UI\n if (!shopify.target.value) {\n return null;\n }\n\n const {groupType, deliveryGroups} =\n shopify.target.value;\n const metafieldKey =\n groupType === 'oneTimePurchase'\n ? 'isGift-oneTimePurchase'\n : 'isGift-subscription';\n const selectedDeliverySelectionGroup =\n shopify.deliverySelectionGroups.value?.find(\n ({selected}) => selected,\n );\n\n const groupLabel =\n groupType === 'oneTimePurchase'\n ? 'one time purchase'\n : 'subscription';\n\n const title =\n deliveryGroups.length > 1\n ? `Your order contains multiple ${groupLabel} shipments.`\n : `Your order contains one ${groupLabel} shipment.`;\n\n let deliverySelectionGroupInfo = '';\n if (selectedDeliverySelectionGroup) {\n deliverySelectionGroupInfo = ` Items will be delivered with the ${selectedDeliverySelectionGroup.title} delivery selection group.`;\n }\n\n return (\n <s-stack gap=\"base\">\n <s-banner\n tone=\"info\"\n heading={`${title}${deliverySelectionGroupInfo}`}\n />\n <s-checkbox\n onChange={onCheckboxChange}\n checked={checked}\n label={`The ${groupLabel} section contains gifts`}\n />\n </s-stack>\n );\n\n // 2. Call API methods to modify the checkout\n async function onCheckboxChange(isChecked) {\n setChecked(isChecked);\n const result =\n await shopify.applyMetafieldChange({\n type: 'updateCartMetafield',\n metafield: {\n namespace: metafieldNamespace,\n key: metafieldKey,\n value: isChecked ? 'yes' : 'no',\n type: 'single_line_text_field',\n },\n });\n console.log(\n 'applyMetafieldsChange result',\n result,\n );\n }\n}\n", "language": "jsx", "title": "Preact" } @@ -197971,7 +197971,7 @@ }, { "name": "Button", - "description": "The button component triggers actions or events, such as submitting forms, opening dialogs, or navigating to other pages. Use button to let users perform specific tasks or initiate interactions throughout the interface.\n\nButtons support various visual styles, tones, and interaction patterns to communicate intent and hierarchy. They can also function as links, guiding users to internal or external destinations. For navigation-focused interactions within text, use [link](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/link). For grouping multiple related buttons, use [button group](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button-group).", + "description": "The button component triggers actions or events, such as submitting forms, opening dialogs, or navigating to other pages. Use buttons to let users perform specific tasks or initiate interactions throughout the interface.\n\nButtons support various visual styles, tones, and interaction patterns to communicate intent and hierarchy. They can also function as links, guiding users to internal or external destinations. For navigation-focused interactions within text, use [link](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/link). For grouping multiple related buttons, use [button group](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button-group).", "category": "Polaris web components", "related": [], "isVisualComponent": true, diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json index 6d2045114f..0146507984 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json @@ -14,7 +14,7 @@ "tabs": [ { "title": "shopify.extension.toml", - "code": "api_version =\"2026-01\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Checkout.jsx\"\n\n[extensions.capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n\n[extensions.capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-key\"\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-other-key\"\n\n[extensions.settings]\n[[extensions.settings.fields]]\nkey = \"field_key\"\ntype = \"boolean\"\nname = \"field-name\"\n[[extensions.settings.fields]]\nkey = \"field_key_2\"\ntype = \"number_integer\"\nname = \"field-name-2\"\n", + "code": "api_version =\"2026-04\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Checkout.jsx\"\n\n[extensions.capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n\n[extensions.capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-key\"\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-other-key\"\n\n[extensions.settings]\n[[extensions.settings.fields]]\nkey = \"field_key\"\ntype = \"boolean\"\nname = \"field-name\"\n[[extensions.settings.fields]]\nkey = \"field_key_2\"\ntype = \"number_integer\"\nname = \"field-name-2\"\n", "language": "toml" } ] @@ -321,7 +321,7 @@ "tabs": [ { "title": "shopify.extension.toml", - "code": "api_version = \"2026-01\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[extensions.settings]\n\n[[extensions.settings.fields]]\nkey = \"banner_title\"\ntype = \"single_line_text_field\"\nname = \"Banner title\"\ndescription = \"Enter a title for the banner.\"\n\n[[extensions.settings.fields.validations]]\nname = \"min\"\nvalue = \"5\"\n[[extensions.settings.fields.validations]]\nname = \"max\"\nvalue = \"20\"\n", + "code": "api_version = \"2026-04\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[extensions.settings]\n\n[[extensions.settings.fields]]\nkey = \"banner_title\"\ntype = \"single_line_text_field\"\nname = \"Banner title\"\ndescription = \"Enter a title for the banner.\"\n\n[[extensions.settings.fields.validations]]\nname = \"min\"\nvalue = \"5\"\n[[extensions.settings.fields.validations]]\nname = \"max\"\nvalue = \"20\"\n", "language": "toml" } ] @@ -576,7 +576,7 @@ "title": "shopify.extension.toml", "tabs": [ { - "code": "api_version = \"2026-01\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"Your checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Extension.jsx\"\n", + "code": "api_version = \"2026-04\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"Your checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Extension.jsx\"\n", "language": "toml" } ] @@ -771,7 +771,7 @@ "tabs": [ { "title": "shopify.extension.toml", - "code": "api_version = \"2026-01\"\n\n[[extensions]]\nname = \"your-extension\"\nhandle = \"your-extension\"\ntype = \"ui_extension\"\n\n# Contents of your existing file...", + "code": "api_version = \"2026-04\"\n\n[[extensions]]\nname = \"your-extension\"\nhandle = \"your-extension\"\ntype = \"ui_extension\"\n\n# Contents of your existing file...", "language": "toml" } ] From 2112416c62bb7d50bc20dd37dd5a8bf707271f2f Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Mon, 9 Mar 2026 20:54:27 -0400 Subject: [PATCH 4/7] Update import type in Thumbnail.ts --- packages/ui-extensions/src/docs/shared/components/Thumbnail.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts b/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts index 875bfdae07..ddef396a67 100644 --- a/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts +++ b/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts @@ -1,4 +1,4 @@ -import {SharedReferenceEntityTemplateSchema} from '../docs-type'; +import type {SharedReferenceEntityTemplateSchema} from '../docs-type'; const data: SharedReferenceEntityTemplateSchema = { name: 'Thumbnail', From d75ec943af99b1f2514224355d733dd3ffc624fd Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Mon, 9 Mar 2026 20:59:47 -0400 Subject: [PATCH 5/7] Update import type in Avatar.ts --- packages/ui-extensions/src/docs/shared/components/Avatar.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/ui-extensions/src/docs/shared/components/Avatar.ts b/packages/ui-extensions/src/docs/shared/components/Avatar.ts index 582f9230b8..60f2b304af 100644 --- a/packages/ui-extensions/src/docs/shared/components/Avatar.ts +++ b/packages/ui-extensions/src/docs/shared/components/Avatar.ts @@ -1,4 +1,4 @@ -import {SharedReferenceEntityTemplateSchema} from '../docs-type'; +import type {SharedReferenceEntityTemplateSchema} from '../docs-type'; const data: SharedReferenceEntityTemplateSchema = { name: 'Avatar', From 12df6f92b68bca036132b3c54a69e28e15330a65 Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Tue, 10 Mar 2026 16:29:09 -0400 Subject: [PATCH 6/7] Add changeset --- .changeset/five-rings-fly.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/five-rings-fly.md diff --git a/.changeset/five-rings-fly.md b/.changeset/five-rings-fly.md new file mode 100644 index 0000000000..67ea4c641b --- /dev/null +++ b/.changeset/five-rings-fly.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +[Checkout] Update code examples From c0d414e5578e8d8410b64d7849f879f9ee45f780 Mon Sep 17 00:00:00 2001 From: Wendy Liu Date: Thu, 12 Mar 2026 13:56:47 -0400 Subject: [PATCH 7/7] Remove generated files --- .../generated/generated_docs_data.json | 209733 --------------- .../generated/generated_static_pages.json | 1511 - .../surfaces/checkout/generated/targets.json | 4196 - 3 files changed, 215440 deletions(-) delete mode 100644 packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json delete mode 100644 packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json delete mode 100644 packages/ui-extensions/docs/surfaces/checkout/generated/targets.json diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json deleted file mode 100644 index ca2f279110..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json +++ /dev/null @@ -1,209733 +0,0 @@ -[ - { - "name": "Addresses", - "description": "The API for interacting with addresses.", - "isVisualComponent": false, - "requires": "level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_AddressApi", - "typeDefinitions": { - "Docs_Standard_AddressApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_AddressApi", - "description": "These types are used to generate the documentation for the API and decipher which properties are available for which APIs. If you are adding a new property and you'd like it to be documented in the API section, then you'll need to specify the property in the appropriate interface below.\n\nNote: These are not exported as part of the package, they are only used for documentation purposes.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - } - ], - "value": "export interface Docs_Standard_AddressApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_AddressApi", - "typeDefinitions": { - "Docs_Checkout_AddressApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_AddressApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - } - ], - "value": "export interface Docs_Checkout_AddressApi\n extends Pick {}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "useBillingAddress", - "description": "Returns the proposed `billingAddress` applied to the checkout.", - "type": "UseBillingAddressGeneratedType", - "typeDefinitions": { - "UseBillingAddressGeneratedType": { - "filePath": "src/surfaces/checkout/preact/billing-address.ts", - "name": "UseBillingAddressGeneratedType", - "description": "Returns the proposed `billingAddress` applied to the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/billing-address.ts", - "description": "", - "name": "MailingAddress | undefined", - "value": "MailingAddress | undefined" - }, - "value": "export function useBillingAddress<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): MailingAddress | undefined {\n const billingAddress = useApi().billingAddress;\n\n if (!billingAddress) {\n throw new ScopeNotGrantedError(\n 'Using billing address requires having billing address permissions granted to your app.',\n );\n }\n\n return useSubscription(billingAddress);\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - } - } - }, - { - "title": "useShippingAddress", - "description": "Returns the proposed `shippingAddress` applied to the checkout.", - "type": "UseShippingAddressGeneratedType", - "typeDefinitions": { - "UseShippingAddressGeneratedType": { - "filePath": "src/surfaces/checkout/preact/shipping-address.ts", - "name": "UseShippingAddressGeneratedType", - "description": "Returns the proposed `shippingAddress` applied to the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/shipping-address.ts", - "description": "", - "name": "ShippingAddress | undefined", - "value": "ShippingAddress | undefined" - }, - "value": "export function useShippingAddress<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): ShippingAddress | undefined {\n const shippingAddress = useApi().shippingAddress;\n\n if (!shippingAddress) {\n throw new ScopeNotGrantedError(\n 'Using shipping address requires having shipping address permissions granted to your app.',\n );\n }\n\n return useSubscription(shippingAddress);\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - } - } - }, - { - "title": "useApplyShippingAddressChange", - "description": "Returns a function to mutate the `shippingAddress` property of checkout.", - "type": "UseApplyShippingAddressChangeGeneratedType", - "typeDefinitions": { - "UseApplyShippingAddressChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/shipping-address.ts", - "name": "UseApplyShippingAddressChangeGeneratedType", - "description": "Returns a function to mutate the `shippingAddress` property of checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/shipping-address.ts", - "description": "", - "name": "(change: ShippingAddressChange) => Promise | undefined", - "value": "(change: ShippingAddressChange) => Promise | undefined" - }, - "value": "export function useApplyShippingAddressChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>():\n | ((change: ShippingAddressChange) => Promise)\n | undefined {\n const api = useApi();\n\n if ('applyShippingAddressChange' in api) {\n return api.applyShippingAddressChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyShippingAddressChange',\n api.extension.target,\n );\n}" - }, - "ShippingAddressChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChange", - "value": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Analytics", - "description": "The API for interacting with web pixels.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_AnalyticsApi", - "typeDefinitions": { - "Docs_Standard_AnalyticsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_AnalyticsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - } - ], - "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick {}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - } - ], - "defaultExample": { - "description": "You can publish analytics events to the Shopify analytics frameworks and they will be propagated to all web pixels on the page.", - "codeblock": { - "title": "Publish", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n shopify.analytics\n .publish('checkout-extension-loaded', {\n extensionName: 'My Extension',\n })\n .then((result) => {\n if (result) {\n console.log(\n 'succesfully published event, web pixels can now recieve this event',\n );\n } else {\n console.log('failed to publish event');\n }\n })\n .catch((error) => {\n console.log('failed to publish event');\n console.log('error', error);\n });\n\n return (\n <s-banner>See console for result</s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "You can submit visitor information to Shopify, these will be sent to the shop backend and not be propagated to web pixels on the page.", - "codeblock": { - "title": "Visitor", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n shopify.analytics\n .visitor({\n email: 'someEmail@example.com',\n phone: '+1 555 555 5555',\n })\n .then((result) => {\n if (result.type === 'success') {\n console.log('Success', result);\n } else {\n console.error('Error', result);\n }\n });\n\n return (\n <s-banner>See console for result</s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Attributes", - "description": "The API for interacting with cart and checkout attributes.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_AttributesApi", - "typeDefinitions": { - "Docs_Standard_AttributesApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_AttributesApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - } - ], - "value": "export interface Docs_Standard_AttributesApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_AttributesApi", - "typeDefinitions": { - "Docs_Checkout_AttributesApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_AttributesApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - } - ], - "value": "export interface Docs_Checkout_AttributesApi\n extends Pick {}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useApplyAttributeChange", - "description": "Returns a function to mutate the `attributes` property of the checkout.", - "type": "UseApplyAttributeChangeGeneratedType", - "typeDefinitions": { - "UseApplyAttributeChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/attributes.ts", - "name": "UseApplyAttributeChangeGeneratedType", - "description": "Returns a function to mutate the `attributes` property of the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/attributes.ts", - "description": "", - "name": "(change: AttributeChange) => Promise", - "value": "(change: AttributeChange) => Promise" - }, - "value": "export function useApplyAttributeChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: AttributeChange) => Promise {\n const api = useApi();\n\n if ('applyAttributeChange' in api) {\n return api.applyAttributeChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyAttributeChange',\n api.extension.target,\n );\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useAttributes", - "description": "Returns the proposed `attributes` applied to the checkout.", - "type": "UseAttributesGeneratedType", - "typeDefinitions": { - "UseAttributesGeneratedType": { - "filePath": "src/surfaces/checkout/preact/attributes.ts", - "name": "UseAttributesGeneratedType", - "description": "Returns the proposed `attributes` applied to the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/attributes.ts", - "description": "", - "name": "Attribute[]", - "value": "Attribute[]" - }, - "value": "export function useAttributes<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Attribute[] {\n return useSubscription(useApi().attributes);\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - } - } - }, - { - "title": "useAttributeValues", - "description": "Returns the values for the specified `attributes` applied to the checkout.", - "type": "UseAttributeValuesGeneratedType", - "typeDefinitions": { - "UseAttributeValuesGeneratedType": { - "filePath": "src/surfaces/checkout/preact/attributes.ts", - "name": "UseAttributeValuesGeneratedType", - "description": "Returns the values for the specified `attributes` applied to the checkout.", - "params": [ - { - "name": "keys", - "description": "An array of attribute keys.", - "value": "string[]", - "filePath": "src/surfaces/checkout/preact/attributes.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/attributes.ts", - "description": "", - "name": "(string | undefined)[]", - "value": "(string | undefined)[]" - }, - "value": "export function useAttributeValues<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(keys: string[]): (string | undefined)[] {\n const attributes = useAttributes();\n\n if (!attributes.length) {\n return [];\n }\n\n return keys.map((key) => {\n const attribute = attributes.find((attribute) => attribute.key === key);\n return attribute?.value;\n });\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Attribute values", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [buyerSelectedFreeTShirt, tshirtSize] =\n useAttributeValues([\n 'buyerSelectedFreeTShirt',\n 'tshirtSize',\n ]);\n\n if (Boolean(buyerSelectedFreeTShirt) === true) {\n return (\n <s-text>\n You selected a free t-shirt, size:{' '}\n {tshirtSize}\n </s-text>\n );\n }\n\n return null;\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "You can add or remove cart and checkout attributes by using the `applyAttributeChange` API.", - "codeblock": { - "title": "Applying changes to attributes", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [giftWrapValue] = useAttributeValues([\n 'giftWrap',\n ]);\n const giftWrap = Boolean(giftWrapValue);\n\n async function toggleGiftWrap() {\n const result = giftWrap\n ? await shopify.applyAttributeChange({\n type: 'removeAttribute',\n key: 'giftWrap',\n })\n : await shopify.applyAttributeChange({\n type: 'updateAttribute',\n key: 'giftWrap',\n value: 'true',\n });\n if (result.type === 'error') {\n console.error(result.message);\n }\n }\n\n return (\n <s-stack>\n <s-text>\n Gift wrapping:{' '}\n {giftWrap ? 'Added' : 'Not set'}\n </s-text>\n <s-button\n onClick={toggleGiftWrap}\n disabled={\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n }\n >\n {giftWrap\n ? 'Remove gift wrap'\n : 'Add gift wrap'}\n </s-button>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Buyer Identity", - "description": "The API for interacting with the buyer identity.", - "requires": "level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_BuyerIdentityApi", - "typeDefinitions": { - "Docs_Standard_BuyerIdentityApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_BuyerIdentityApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - } - ], - "value": "export interface Docs_Standard_BuyerIdentityApi\n extends Pick {}" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - } - } - }, - { - "title": "useCustomer", - "description": "Returns the current `Customer`. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.", - "type": "UseCustomerGeneratedType", - "typeDefinitions": { - "UseCustomerGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "name": "UseCustomerGeneratedType", - "description": "Returns the current `Customer`.\n\nThe value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "description": "", - "name": "Customer | undefined", - "value": "Customer | undefined" - }, - "value": "export function useCustomer<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Customer | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.customer);\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useEmail", - "description": "Returns the email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.", - "type": "UseEmailGeneratedType", - "typeDefinitions": { - "UseEmailGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "name": "UseEmailGeneratedType", - "description": "Returns the email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "description": "", - "name": "string | undefined", - "value": "string | undefined" - }, - "value": "export function useEmail<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): string | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.email);\n}" - } - } - }, - { - "title": "usePhone", - "description": "Returns the phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.", - "type": "UsePhoneGeneratedType", - "typeDefinitions": { - "UsePhoneGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "name": "UsePhoneGeneratedType", - "description": "Returns the phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "description": "", - "name": "string | undefined", - "value": "string | undefined" - }, - "value": "export function usePhone<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): string | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.phone);\n}" - } - } - }, - { - "title": "usePurchasingCompany", - "description": "Provides information about the company and its location that the business customer is purchasing on behalf of during a B2B checkout. It includes details that can be utilized to identify both the company and its corresponding location to which the business customer belongs. \n \n The value is `undefined` if a business customer isn't logged in. This function throws an error if the app doesn't have access to customer data.", - "type": "UsePurchasingCompanyGeneratedType", - "typeDefinitions": { - "UsePurchasingCompanyGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "name": "UsePurchasingCompanyGeneratedType", - "description": "Provides information about the company and its location that the business customer is purchasing on behalf of during a B2B checkout. It includes details that can be utilized to identify both the company and its corresponding location to which the business customer belongs.\n\nThe value is `undefined` if a business customer isn't logged in. This function throws an error if the app doesn't have access to customer data.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", - "description": "", - "name": "PurchasingCompany | undefined", - "value": "PurchasingCompany | undefined" - }, - "value": "export function usePurchasingCompany<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): PurchasingCompany | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.purchasingCompany);\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Buyer Journey", - "description": "The API for interacting with the buyer journey.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_BuyerJourneyApi", - "typeDefinitions": { - "Docs_Standard_BuyerJourneyApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_BuyerJourneyApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - } - ], - "value": "export interface Docs_Standard_BuyerJourneyApi\n extends Pick {}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - } - } - }, - { - "title": "useBuyerJourney", - "description": "Returns the buyerJourney details on buyer progression in checkout.", - "type": "UseBuyerJourneyGeneratedType", - "typeDefinitions": { - "UseBuyerJourneyGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "name": "UseBuyerJourneyGeneratedType", - "description": "Returns the `buyerJourney` details on buyer progression in checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "description": "", - "name": "BuyerJourney", - "value": "BuyerJourney" - }, - "value": "export function useBuyerJourney<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): BuyerJourney {\n const api = useApi();\n\n return api.buyerJourney;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - } - } - }, - { - "title": "useBuyerJourneyCompleted", - "description": "\n Returns `true` if the buyer completed submitting their order.\n For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n ", - "type": "UseBuyerJourneyCompletedGeneratedType", - "typeDefinitions": { - "UseBuyerJourneyCompletedGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "name": "UseBuyerJourneyCompletedGeneratedType", - "description": "Returns true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "description": "", - "name": "false | true", - "value": "false | true" - }, - "value": "export function useBuyerJourneyCompleted<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): boolean {\n const api = useApi();\n return useSubscription(api.buyerJourney.completed);\n}" - } - } - }, - { - "title": "useBuyerJourneyIntercept", - "description": "\n Installs a function for intercepting and preventing progress on checkout.\n To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n If you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n `useBuyerJourneyIntercept()` should be called at the top level of the extension, not within an embedded or child component, to avoid errors should the child component get destroyed.\n It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress.\n ", - "type": "UseBuyerJourneyInterceptGeneratedType", - "typeDefinitions": { - "UseBuyerJourneyInterceptGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "name": "UseBuyerJourneyInterceptGeneratedType", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\n`useBuyerJourneyIntercept()` should be called at the top level of the extension, not within an embedded or child component, to avoid errors should the child component get destroyed.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress.", - "params": [ - { - "name": "interceptor", - "description": "", - "value": "Interceptor", - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "description": "", - "name": "void", - "value": "void" - }, - "value": "export function useBuyerJourneyIntercept<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(interceptor: Interceptor): void {\n const api = useApi();\n\n const interceptorRef = useRef(interceptor);\n interceptorRef.current = interceptor;\n\n return useEffect(() => {\n const teardownPromise = api.buyerJourney.intercept((interceptorProps) =>\n interceptorRef.current(interceptorProps),\n );\n\n return () => {\n teardownPromise.then((teardown) => teardown()).catch(() => {});\n };\n }, [api.buyerJourney]);\n}" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - } - } - }, - { - "title": "useBuyerJourneySteps", - "description": "\n Returns all possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n ", - "type": "UseBuyerJourneyStepsGeneratedType", - "typeDefinitions": { - "UseBuyerJourneyStepsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "name": "UseBuyerJourneyStepsGeneratedType", - "description": "Returns all possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "description": "", - "name": "BuyerJourneyStep[]", - "value": "BuyerJourneyStep[]" - }, - "value": "export function useBuyerJourneySteps<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): BuyerJourneyStep[] {\n const api = useApi();\n\n if (!('buyerJourney' in api) || !api.buyerJourney) {\n throw new ExtensionHasNoMethodError('buyerJourney', api.extension.target);\n }\n\n return useSubscription(api.buyerJourney.steps);\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - } - } - }, - { - "title": "useBuyerJourneyActiveStep", - "description": "\n Returns the buyer journey step that the buyer is currently on.\n ", - "type": "UseBuyerJourneyActiveStepGeneratedType", - "typeDefinitions": { - "UseBuyerJourneyActiveStepGeneratedType": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "name": "UseBuyerJourneyActiveStepGeneratedType", - "description": "Returns the buyer journey step that the buyer is currently on.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", - "description": "", - "name": "BuyerJourneyStep | undefined", - "value": "BuyerJourneyStep | undefined" - }, - "value": "export function useBuyerJourneyActiveStep<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): BuyerJourneyStep | undefined {\n const api = useApi();\n\n if (!('buyerJourney' in api) || !api.buyerJourney) {\n throw new ExtensionHasNoMethodError('buyerJourney', api.extension.target);\n }\n\n const steps = useSubscription(api.buyerJourney.steps);\n const activeStep = useSubscription(api.buyerJourney.activeStep);\n\n return activeStep\n ? steps.find(({handle}) => handle === activeStep.handle)\n : undefined;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - } - } - } - ], - "defaultExample": { - "description": "Intercept and prevent a buyer's progress through checkout while targeting a specific checkout UI field.\n See the [validation tutorial](/docs/apps/checkout/validation) for more examples and best practices.", - "codeblock": { - "title": "Block progress and show error for a checkout UI field", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {\n useBuyerJourneyIntercept,\n useExtensionEditor,\n useExtensionCapability,\n} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const editorType = useExtensionEditor()?.type;\n const blockProgressGranted =\n useExtensionCapability('block_progress');\n\n useBuyerJourneyIntercept(\n ({canBlockProgress}) => {\n return canBlockProgress &&\n shopify.shippingAddress.value\n ?.countryCode &&\n shopify.shippingAddress.value\n .countryCode !== 'CA'\n ? {\n behavior: 'block',\n reason: 'Invalid shipping country',\n errors: [\n {\n message:\n 'Sorry, we can only ship to Canada',\n // Show an error underneath the country code field\n target:\n '$.cart.deliveryGroups[0].deliveryAddress.countryCode',\n },\n {\n // In addition, show an error at the page level\n message:\n 'Please use a different address.',\n },\n ],\n }\n : {\n behavior: 'allow',\n };\n },\n );\n\n return (\n <>\n {editorType === 'checkout' &&\n !blockProgressGranted ? (\n <s-banner\n tone=\"warning\"\n heading=\"This app may be misconfigured\"\n >\n To allow this app to block checkout,\n enable this behavior in \"Checkout\n behavior\" settings.\n </s-banner>\n ) : null}\n </>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "In addition to targeting checkout UI fields, you can also pass errors to the page level or render the error in your extension.", - "examples": [ - { - "description": "Intercept and prevent a buyer's progress through checkout while displaying an error message at the page level.\n See the [validation tutorial](/docs/apps/checkout/validation) for more examples and best practices.", - "codeblock": { - "title": "Block progress and show error at page level", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {\n useBuyerJourneyIntercept,\n useExtensionEditor,\n useExtensionCapability,\n} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const editorType = useExtensionEditor()?.type;\n const blockProgressGranted =\n useExtensionCapability('block_progress');\n\n useBuyerJourneyIntercept(\n ({canBlockProgress}) => {\n return canBlockProgress &&\n shopify.shippingAddress.value\n ?.countryCode &&\n shopify.shippingAddress.value\n .countryCode !== 'CA'\n ? {\n behavior: 'block',\n reason: 'Invalid shipping country',\n errors: [\n {\n // An error without a `target` property is shown at page level\n message:\n 'Sorry, we can only ship to Canada',\n },\n ],\n }\n : {\n behavior: 'allow',\n };\n },\n );\n\n return (\n <>\n {editorType === 'checkout' &&\n !blockProgressGranted ? (\n <s-banner\n tone=\"warning\"\n heading=\"This app may be misconfigured\"\n >\n To allow this app to block checkout,\n enable this behavior in \"Checkout\n behavior\" settings.\n </s-banner>\n ) : null}\n </>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "Intercept and prevent a buyer's progress through checkout while displaying an error message in your extension.\n See the [validation tutorial](/docs/apps/checkout/validation) for more examples and best practices.", - "codeblock": { - "title": "Block progress and show error in your extension", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nimport {\n useBuyerJourneyIntercept,\n useExtensionEditor,\n useExtensionCapability,\n} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [showError, setShowError] =\n useState(false);\n const editorType = useExtensionEditor()?.type;\n const blockProgressGranted =\n useExtensionCapability('block_progress');\n\n useBuyerJourneyIntercept(\n ({canBlockProgress}) => {\n return canBlockProgress &&\n shopify.target.value.quantity > 1\n ? {\n behavior: 'block',\n reason: 'limited stock',\n perform: (result) => {\n if (result.behavior === 'block') {\n setShowError(true);\n }\n },\n }\n : {\n behavior: 'allow',\n perform: () => {\n setShowError(false);\n },\n };\n },\n );\n\n return (\n <>\n {editorType === 'checkout' &&\n !blockProgressGranted ? (\n <s-banner\n tone=\"warning\"\n heading=\"This app may be misconfigured\"\n >\n To allow this app to block checkout,\n enable this behavior in \"Checkout\n behavior\" settings.\n </s-banner>\n ) : null}\n {showError ? (\n <s-banner tone=\"critical\">\n This item has a limit of one per\n customer.\n </s-banner>\n ) : null}\n </>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - }, - "related": [ - { - "subtitle": "Tutorial", - "name": "Validating fields at checkout", - "url": "/docs/apps/checkout/validation/fields", - "type": "tutorial" - }, - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Cart Instructions", - "description": "Instructions used to create the checkout.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_CartInstructionsApi", - "typeDefinitions": { - "Docs_Standard_CartInstructionsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_CartInstructionsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - } - ], - "value": "export interface Docs_Standard_CartInstructionsApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - } - } - }, - { - "title": "useInstructions", - "description": "Returns the cart instructions used to create the checkout and possibly limit extension capabilities.", - "type": "UseInstructionsGeneratedType", - "typeDefinitions": { - "UseInstructionsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/instructions.ts", - "name": "UseInstructionsGeneratedType", - "description": "Returns the cart instructions used to create the checkout and possibly limit extension capabilities.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/instructions.ts", - "description": "", - "name": "CartInstructions", - "value": "CartInstructions" - }, - "value": "export function useInstructions<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartInstructions {\n return useSubscription(useApi().instructions);\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - } - } - } - ], - "defaultExample": { - "description": "\n Check `instructions.discounts.canUpdateDiscountCodes` before calling `applyDiscountCodeChange()`.\n ", - "codeblock": { - "title": "Discounts", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.discounts\n .canUpdateDiscountCodes\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyDiscountCodeChange({\n type: 'addDiscountCode',\n code: 'FREE_SHIPPING',\n })\n }\n >\n Apply your loyalty discount\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n Loyalty discounts are unavailable\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "Use the cart instructions API to determine if the affected APIs are available in checkout.", - "examples": [ - { - "description": "\n Check `instructions.attributes.canUpdateAttributes` before calling `applyAttributeChange()`.\n ", - "codeblock": { - "title": "Attributes", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyAttributeChange({\n type: 'updateAttribute',\n key: 'loyaltyPoints',\n value: '100',\n })\n }\n >\n Apply 100 loyalty points\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n Loyalty points are unavailable\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "\n Check `instructions.delivery.canSelectCustomAddress` before calling `applyShippingAddressChange()`. When `true`, this instruction implies that extensions can change the shipping address.\n ", - "codeblock": { - "title": "Delivery", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.delivery\n .canSelectCustomAddress\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyShippingAddressChange({\n type: 'updateShippingAddress',\n address: {\n zip: '90201',\n },\n })\n }\n >\n Change your postal code\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n Shipping address cannot be modified\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "\n Check `instructions.discounts.canUpdateDiscountCodes` before calling `applyDiscountCodeChange()`.\n ", - "codeblock": { - "title": "Discounts", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.discounts\n .canUpdateDiscountCodes\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyDiscountCodeChange({\n type: 'addDiscountCode',\n code: 'FREE_SHIPPING',\n })\n }\n >\n Apply your loyalty discount\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n Loyalty discounts are unavailable\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "\n Check `instructions.lines.canAddCartLine` or `instructions.lines.canRemoveCartLine` or `instructions.lines.canUpdateCartLine` before calling `applyCartLinesChange()`.\n ", - "codeblock": { - "title": "Lines", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.lines\n .canAddCartLine\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyCartLinesChange({\n type: 'addCartLine',\n merchandiseId:\n 'gid://shopify/product/1234',\n quantity: 1,\n })\n }\n >\n Add a free gift to your order\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n The products in your cart cannot be\n modified\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "\n Check `instructions.metafields.canSetCartMetafields` or `instructions.metafields.canDeleteCartMetafields` before calling `applyMetafieldChange()` if you are working with cart metafields.\n ", - "codeblock": { - "title": "Metafields", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.metafields\n .canSetCartMetafields\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyMetafieldChange({\n type: 'updateCartMetafield',\n metafield: {\n namespace: 'loyalty',\n key: 'loyaltyPoints',\n value: '100',\n type: 'string',\n },\n })\n }\n >\n Apply 100 loyalty points\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n Loyalty points are unavailable\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "\n Check `instructions.notes.canUpdateNote` before calling `applyNoteChange()`.\n ", - "codeblock": { - "title": "Notes", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.instructions.value.notes.canUpdateNote\n ) {\n return (\n <s-button\n onClick={() =>\n shopify.applyNoteChange({\n type: 'updateNote',\n note: 'Please include a free gift.',\n })\n }\n >\n Include a free gift with your order\n </s-button>\n );\n } else {\n return (\n <s-banner tone=\"warning\">\n Free gifts cannot be added to this order\n </s-banner>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Cart Lines", - "description": "The API for interacting with the cart lines.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_CartLinesApi", - "typeDefinitions": { - "Docs_Standard_CartLinesApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_CartLinesApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - } - ], - "value": "export interface Docs_Standard_CartLinesApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "useCartLines", - "description": "Returns the current line items for the checkout, and automatically re-renders your component if line items are added, removed, or updated.", - "type": "UseCartLinesGeneratedType", - "typeDefinitions": { - "UseCartLinesGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cart-lines.ts", - "name": "UseCartLinesGeneratedType", - "description": "Returns the current line items for the checkout, and automatically re-renders your component if line items are added, removed, or updated.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cart-lines.ts", - "description": "", - "name": "CartLine[]", - "value": "CartLine[]" - }, - "value": "export function useCartLines<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartLine[] {\n const {lines} = useApi();\n\n return useSubscription(lines);\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_CartLinesApi", - "typeDefinitions": { - "Docs_Checkout_CartLinesApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_CartLinesApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - } - ], - "value": "export interface Docs_Checkout_CartLinesApi\n extends Pick {}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useApplyCartLinesChange", - "description": "Returns a function to mutate the `lines` property of checkout.", - "type": "UseApplyCartLinesChangeGeneratedType", - "typeDefinitions": { - "UseApplyCartLinesChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cart-lines.ts", - "name": "UseApplyCartLinesChangeGeneratedType", - "description": "Returns a function to mutate the `lines` property of checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cart-lines.ts", - "description": "", - "name": "(change: CartLineChange) => Promise", - "value": "(change: CartLineChange) => Promise" - }, - "value": "export function useApplyCartLinesChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: CartLineChange) => Promise {\n const api = useApi();\n\n if ('applyCartLinesChange' in api) {\n return api.applyCartLinesChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyCartLinesChange',\n api.extension.target,\n );\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "CartLineItemApi", - "description": "The API object provided to `cart-line-item` extension targets.", - "type": "Docs_CartLineItem_CartLinesApi", - "typeDefinitions": { - "Docs_CartLineItem_CartLinesApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_CartLineItem_CartLinesApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`." - } - ], - "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "useTarget", - "description": "Returns the cart line the extension is attached to. This hook can only be used by `cart-line-item` extension targets. Until version `2023-04`, this hook returned a `PresentmentCartLine object`.", - "type": "UseTargetGeneratedType", - "typeDefinitions": { - "UseTargetGeneratedType": { - "filePath": "src/surfaces/checkout/preact/target.ts", - "name": "UseTargetGeneratedType", - "description": "Returns the cart line the extension is attached to. This hook can only be used by extensions in the `purchase.cart-line-item.line-components.render`, `purchase.checkout.cart-line-item.render-after`, and `purchase.thank-you.cart-line-item.render-after` extension targets. Until version `2023-04`, this hook returned a `PresentmentCartLine` object.\n\n> Caution: Deprecated as of version `2023-10`, use `useCartLineTarget()` instead.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/target.ts", - "description": "", - "name": "CartLine", - "value": "CartLine" - }, - "value": "export function useTarget(): CartLine {\n const api = useApi<\n | 'purchase.cart-line-item.line-components.render'\n | 'purchase.checkout.cart-line-item.render-after'\n | 'purchase.thank-you.cart-line-item.render-after'\n >();\n if (!api.target) {\n throw new ExtensionHasNoTargetError(api.extension.target);\n }\n\n return useSubscription(api.target);\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "useCartLineTarget", - "description": "Returns the cart line the extension is attached to. This hook can only be used by `cart-line-item` extension targets", - "type": "UseCartLineTargetGeneratedType", - "typeDefinitions": { - "UseCartLineTargetGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cart-line-target.ts", - "name": "UseCartLineTargetGeneratedType", - "description": "Returns the cart line the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- `purchase.cart-line-item.line-components.render`\n- `purchase.checkout.cart-line-item.render-after`\n- `purchase.thank-you.cart-line-item.render-after`", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cart-line-target.ts", - "description": "", - "name": "CartLine", - "value": "CartLine" - }, - "value": "export function useCartLineTarget(): CartLine {\n const api = useApi<\n | 'purchase.cart-line-item.line-components.render'\n | 'purchase.checkout.cart-line-item.render-after'\n | 'purchase.thank-you.cart-line-item.render-after'\n >();\n if (!api.target) {\n throw new ExtensionHasNoTargetError(\n 'useCartLineTarget',\n api.extension.target,\n );\n }\n\n return useSubscription(api.target);\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-text>\n Line item title:{' '}\n {shopify.target.value.merchandise.title}\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Checkout Token", - "description": "The API for interacting with the token of a checkout.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_CheckoutTokenApi", - "typeDefinitions": { - "Docs_Standard_CheckoutTokenApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_CheckoutTokenApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - } - ], - "value": "export interface Docs_Standard_CheckoutTokenApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - } - } - }, - { - "title": "useCheckoutToken", - "description": "Returns a stable id that represents the current checkout.", - "type": "UseCheckoutTokenGeneratedType", - "typeDefinitions": { - "UseCheckoutTokenGeneratedType": { - "filePath": "src/surfaces/checkout/preact/checkout-token.ts", - "name": "UseCheckoutTokenGeneratedType", - "description": "A stable id that represents the current checkout.\n\nMatches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object).", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/checkout-token.ts", - "description": "", - "name": "CheckoutToken | undefined", - "value": "CheckoutToken | undefined" - }, - "value": "export function useCheckoutToken<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CheckoutToken | undefined {\n return useSubscription(useApi().checkoutToken);\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Cost", - "description": "The API for interacting with the cost of a checkout.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_CostApi", - "typeDefinitions": { - "Docs_Standard_CostApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_CostApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - } - ], - "value": "export interface Docs_Standard_CostApi extends Pick {}" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useSubtotalAmount", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout.", - "type": "UseSubtotalAmountGeneratedType", - "typeDefinitions": { - "UseSubtotalAmountGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "name": "UseSubtotalAmountGeneratedType", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "description": "", - "name": "Money", - "value": "Money" - }, - "value": "export function useSubtotalAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money {\n return useSubscription(useApi().cost.subtotalAmount);\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useTotoalShippingAmount", - "description": "Returns a `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step.", - "type": "UseTotalShippingAmountGeneratedType", - "typeDefinitions": { - "UseTotalShippingAmountGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "name": "UseTotalShippingAmountGeneratedType", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "description": "", - "name": "Money | undefined", - "value": "Money | undefined" - }, - "value": "export function useTotalShippingAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money | undefined {\n return useSubscription(useApi().cost.totalShippingAmount);\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useTotalTaxAmount", - "description": "Returns a `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable.", - "type": "UseTotalTaxAmountGeneratedType", - "typeDefinitions": { - "UseTotalTaxAmountGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "name": "UseTotalTaxAmountGeneratedType", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "description": "", - "name": "Money | undefined", - "value": "Money | undefined" - }, - "value": "export function useTotalTaxAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money | undefined {\n return useSubscription(useApi().cost.totalTaxAmount);\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useTotalAmount", - "description": "Returns a `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated. Applied gift cards and store credit are excluded.", - "type": "UseTotalAmountGeneratedType", - "typeDefinitions": { - "UseTotalAmountGeneratedType": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "name": "UseTotalAmountGeneratedType", - "description": "Returns a `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/cost.ts", - "description": "", - "name": "Money", - "value": "Money" - }, - "value": "export function useTotalAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money {\n return useSubscription(useApi().cost.totalAmount);\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Customer Privacy", - "description": "The API for interacting with a customer's privacy consent. It is similar to the [Customer Privacy API in storefront](/docs/api/customer-privacy).", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_CustomerPrivacyApi", - "typeDefinitions": { - "Docs_Standard_CustomerPrivacyApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_CustomerPrivacyApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - } - ], - "value": "export interface Docs_Standard_CustomerPrivacyApi\n extends Pick {}" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - } - } - }, - { - "title": "useCustomerPrivacy", - "description": "Returns the current customer privacy settings and metadata and re-renders your component if the customer privacy settings change.", - "type": "UseCustomerPrivacyGeneratedType", - "typeDefinitions": { - "UseCustomerPrivacyGeneratedType": { - "filePath": "src/surfaces/checkout/preact/customer-privacy.ts", - "name": "UseCustomerPrivacyGeneratedType", - "description": "Returns the current customer privacy settings and metadata and re-renders your component if the customer privacy settings change.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/customer-privacy.ts", - "description": "", - "name": "CustomerPrivacy", - "value": "CustomerPrivacy" - }, - "value": "export function useCustomerPrivacy<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CustomerPrivacy {\n return useSubscription(useApi().customerPrivacy);\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Read Customer Privacy", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {\n analytics,\n marketing,\n preferences,\n saleOfData,\n } =\n shopify.customerPrivacy.value.visitorConsent;\n\n console.log('analytics', analytics);\n console.log('marketing', marketing);\n console.log('preferences', preferences);\n console.log('saleOfData', saleOfData);\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Delivery", - "description": "\n The APIs for interacting with delivery and shipping options.\n\n > Tip: Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available.\n ", - "overviewPreviewDescription": "The APIs for interacting with delivery and shipping options.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_DeliveryApi", - "typeDefinitions": { - "Docs_Standard_DeliveryApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_DeliveryApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - } - ], - "value": "export interface Docs_Standard_DeliveryApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "useDeliveryGroup", - "description": "Returns the full expanded details of a delivery group and automatically re-renders your component when that delivery group changes.", - "type": "UseDeliveryGroupGeneratedType", - "typeDefinitions": { - "UseDeliveryGroupGeneratedType": { - "filePath": "src/surfaces/checkout/preact/delivery-group.ts", - "name": "UseDeliveryGroupGeneratedType", - "description": "Returns the full expanded details of a delivery group and automatically re-renders your component when that delivery group changes.", - "params": [ - { - "name": "deliveryGroup", - "description": "", - "value": "DeliveryGroup", - "filePath": "src/surfaces/checkout/preact/delivery-group.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/delivery-group.ts", - "description": "", - "name": "DeliveryGroupDetails | undefined", - "value": "DeliveryGroupDetails | undefined" - }, - "value": "export function useDeliveryGroup<\n ID extends RenderExtensionTarget = RenderExtensionTarget,\n>(deliveryGroup: DeliveryGroup | undefined): DeliveryGroupDetails | undefined {\n const {lines} = useApi();\n const cartLines = useSubscription(lines);\n\n return useMemo(() => {\n if (!deliveryGroup) {\n return undefined;\n }\n\n const deliveryGroupDetails = {\n ...deliveryGroup,\n selectedDeliveryOption: getSelectedDeliveryOption(deliveryGroup),\n targetedCartLines: getTargetedCartLines(deliveryGroup, cartLines),\n };\n\n return deliveryGroupDetails;\n }, [deliveryGroup, cartLines]);\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "DeliveryGroupDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroupDetails", - "description": "Represents a DeliveryGroup with expanded reference fields and full details.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOption", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLine[]", - "description": "The cart lines associated to the delivery group." - } - ], - "value": "export interface DeliveryGroupDetails extends DeliveryGroup {\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOption;\n\n /**\n * The cart lines associated to the delivery group.\n */\n targetedCartLines: CartLine[];\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "useDeliveryGroups", - "description": "Returns the current delivery groups for the checkout, and automatically re-renders your component when delivery address or delivery option selection changes.", - "type": "UseDeliveryGroupsGeneratedType", - "typeDefinitions": { - "UseDeliveryGroupsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/delivery-groups.ts", - "name": "UseDeliveryGroupsGeneratedType", - "description": "Returns the current delivery groups for the checkout, and automatically re-renders your component when delivery address or delivery option selection changes.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/delivery-groups.ts", - "description": "", - "name": "DeliveryGroup[]", - "value": "DeliveryGroup[]" - }, - "value": "export function useDeliveryGroups<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): DeliveryGroup[] {\n const api = useApi();\n return useSubscription(api.deliveryGroups);\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "Shipping Option", - "description": "This API object is provided to extensions registered for the `purchase.checkout.shipping-option-item.render-after` and `purchase.checkout.shipping-option-item.details.render` extension targets.", - "type": "ShippingOptionItemApi", - "typeDefinitions": { - "ShippingOptionItemApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the shipping option the extension is attached to is currently selected in the UI." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "renderMode", - "value": "ShippingOptionItemRenderMode", - "description": "The render mode of the shipping option." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The shipping option the extension is attached to." - } - ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the shipping option the extension is attached to is currently selected in the UI.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of the shipping option.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "ShippingOptionItemRenderMode": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemRenderMode", - "description": "The render mode of a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Whether the shipping option is rendered in an overlay." - } - ], - "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay.\n */\n overlay: boolean;\n}" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - } - } - }, - { - "title": "useShippingOptionTarget", - "description": "Returns the shipping option for the `purchase.checkout.shipping-option-item.render-after` and `purchase.checkout.shipping-option-item.details.render` attached extensions.", - "type": "UseShippingOptionTargetGeneratedType", - "typeDefinitions": { - "UseShippingOptionTargetGeneratedType": { - "filePath": "src/surfaces/checkout/preact/shipping-option-target.ts", - "name": "UseShippingOptionTargetGeneratedType", - "description": "Returns the shipping option the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- `purchase.checkout.shipping-option-item.render-after`\n- `purchase.checkout.shipping-option-item.details.render`", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/shipping-option-target.ts", - "description": "", - "name": "{\n shippingOptionTarget: ShippingOption;\n isTargetSelected: boolean;\n renderMode: ShippingOptionItemRenderMode;\n}", - "value": "{\n shippingOptionTarget: ShippingOption;\n isTargetSelected: boolean;\n renderMode: ShippingOptionItemRenderMode;\n}" - }, - "value": "export function useShippingOptionTarget(): {\n shippingOptionTarget: ShippingOption;\n isTargetSelected: boolean;\n renderMode: ShippingOptionItemRenderMode;\n} {\n const api = useApi<\n | 'purchase.checkout.shipping-option-item.render-after'\n | 'purchase.checkout.shipping-option-item.details.render'\n >();\n if (!api.target || api.isTargetSelected === undefined) {\n throw new ExtensionHasNoTargetError(\n 'useShippingOptionTarget',\n api.extension.target,\n );\n }\n\n const shippingOptionTarget = useSubscription(api.target);\n const isTargetSelected = useSubscription(api.isTargetSelected);\n const renderMode = api.renderMode;\n\n const shippingOption = useMemo(() => {\n return {\n shippingOptionTarget,\n isTargetSelected,\n renderMode,\n };\n }, [shippingOptionTarget, isTargetSelected, renderMode]);\n\n return shippingOption;\n}" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "ShippingOptionItemRenderMode": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemRenderMode", - "description": "The render mode of a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Whether the shipping option is rendered in an overlay." - } - ], - "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay.\n */\n overlay: boolean;\n}" - } - } - }, - { - "title": "ShippingOptionListApi", - "description": "This API object is provided to extensions registered for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` extension targets.", - "type": "ShippingOptionListApi", - "typeDefinitions": { - "ShippingOptionListApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "ShippingOptionListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliverySelectionGroups", - "value": "SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >", - "description": "The list of selection groups available to the buyers. The property will be undefined when no such groups are available." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type." - } - ], - "value": "export interface ShippingOptionListApi {\n /**\n * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.\n */\n target: SubscribableSignalLike;\n /**\n * The list of selection groups available to the buyers. The property will be undefined when no such groups are available.\n */\n deliverySelectionGroups: SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "DeliverySelectionGroup": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliverySelectionGroup", - "description": "A selection group for delivery options.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "associatedDeliveryOptions", - "value": "DeliveryOptionReference[]", - "description": "The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The sum of each delivery option's cost." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The sum of each delivery option's cost after discounts." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The handle of the selection group." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "If the selection group is selected." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The localized title of the selection group." - } - ], - "value": "export interface DeliverySelectionGroup {\n /**\n * The handle of the selection group.\n */\n handle: string;\n /**\n * If the selection group is selected.\n */\n selected: boolean;\n /**\n * The localized title of the selection group.\n */\n title: string;\n /**\n * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The sum of each delivery option's cost.\n */\n cost: Money;\n /**\n * The sum of each delivery option's cost after discounts.\n */\n costAfterDiscounts: Money;\n}" - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryGroupList": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliveryGroupList", - "description": "The delivery group list the extension is associated to.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "DeliveryGroup[]", - "description": "The delivery groups that compose this list." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The group type of the delivery group list." - } - ], - "value": "export interface DeliveryGroupList {\n /**\n * The group type of the delivery group list.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups that compose this list.\n */\n deliveryGroups: DeliveryGroup[];\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "useDeliveryGroupTarget", - "description": "Returns the delivery group for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions. This is deprecated, use `useDeliveryGroupListTarget()` instead.", - "type": "UseDeliveryGroupTargetGeneratedType", - "typeDefinitions": { - "UseDeliveryGroupTargetGeneratedType": { - "filePath": "src/surfaces/checkout/preact/delivery-group-target.ts", - "name": "UseDeliveryGroupTargetGeneratedType", - "description": "Returns the delivery group the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- purchase.checkout.shipping-option-list.render-before\n- purchase.checkout.shipping-option-list.render-after\n\n> Caution: Deprecated as of version `2024-07`, use `useDeliveryGroupListTarget()` instead.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/delivery-group-target.ts", - "description": "", - "name": "DeliveryGroup | undefined", - "value": "DeliveryGroup | undefined" - }, - "value": "export function useDeliveryGroupTarget(): DeliveryGroup | undefined {\n const api = useApi<\n | 'purchase.checkout.shipping-option-list.render-before'\n | 'purchase.checkout.shipping-option-list.render-after'\n >();\n\n const target = useSubscription(api.target);\n return target?.deliveryGroups[0];\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "useDeliveryGroupListTarget", - "description": "Returns the delivery group list for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions.", - "type": "UseDeliveryGroupListTargetGeneratedType", - "typeDefinitions": { - "UseDeliveryGroupListTargetGeneratedType": { - "filePath": "src/surfaces/checkout/preact/delivery-group-list-target.ts", - "name": "UseDeliveryGroupListTargetGeneratedType", - "description": "Returns the delivery group list the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- purchase.checkout.shipping-option-list.render-before\n- purchase.checkout.shipping-option-list.render-after", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/delivery-group-list-target.ts", - "description": "", - "name": "DeliveryGroupList | undefined", - "value": "DeliveryGroupList | undefined" - }, - "value": "export function useDeliveryGroupListTarget(): DeliveryGroupList | undefined {\n const api = useApi<\n | 'purchase.checkout.shipping-option-list.render-before'\n | 'purchase.checkout.shipping-option-list.render-after'\n >();\n\n return useSubscription(api.target);\n}" - }, - "DeliveryGroupList": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliveryGroupList", - "description": "The delivery group list the extension is associated to.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "DeliveryGroup[]", - "description": "The delivery groups that compose this list." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The group type of the delivery group list." - } - ], - "value": "export interface DeliveryGroupList {\n /**\n * The group type of the delivery group list.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups that compose this list.\n */\n deliveryGroups: DeliveryGroup[];\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "useDeliverySelectionGroups", - "description": "Returns the delivery selection groups for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions.", - "type": "UseDeliverySelectionGroupsGeneratedType", - "typeDefinitions": { - "UseDeliverySelectionGroupsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/delivery-selection-groups.ts", - "name": "UseDeliverySelectionGroupsGeneratedType", - "description": "Returns the list of delivery selection groups available to the buyers. This hook can only be used by extensions in the following extension targets:\n- purchase.checkout.shipping-option-list.render-before\n- purchase.checkout.shipping-option-list.render-after", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/delivery-selection-groups.ts", - "description": "", - "name": "| DeliverySelectionGroup[]\n | undefined", - "value": "| DeliverySelectionGroup[]\n | undefined" - }, - "value": "export function useDeliverySelectionGroups():\n | DeliverySelectionGroup[]\n | undefined {\n const api = useApi<\n | 'purchase.checkout.shipping-option-list.render-before'\n | 'purchase.checkout.shipping-option-list.render-after'\n >();\n\n return useSubscription(api.deliverySelectionGroups);\n}" - }, - "DeliverySelectionGroup": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliverySelectionGroup", - "description": "A selection group for delivery options.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "associatedDeliveryOptions", - "value": "DeliveryOptionReference[]", - "description": "The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The sum of each delivery option's cost." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The sum of each delivery option's cost after discounts." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The handle of the selection group." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "If the selection group is selected." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The localized title of the selection group." - } - ], - "value": "export interface DeliverySelectionGroup {\n /**\n * The handle of the selection group.\n */\n handle: string;\n /**\n * If the selection group is selected.\n */\n selected: boolean;\n /**\n * The localized title of the selection group.\n */\n title: string;\n /**\n * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The sum of each delivery option's cost.\n */\n cost: Money;\n /**\n * The sum of each delivery option's cost after discounts.\n */\n costAfterDiscounts: Money;\n}" - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "PickupPointListApi", - "description": "This API object is provided to extensions registered for the `purchase.checkout.pickup-point-list.render-after` and `purchase.checkout.pickup-point-list.render-after` extension target.", - "type": "PickupPointListApi", - "typeDefinitions": { - "PickupPointListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "name": "PickupPointListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "PickupLocationListApi", - "description": "This API object is provided to extensions registered for the `purchase.checkout.pickup-location-list.render-after` and `purchase.checkout.pickup-location-list.render-after` extension target.", - "type": "PickupLocationListApi", - "typeDefinitions": { - "PickupLocationListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "name": "PickupLocationListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupLocationListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "PickupLocationItemApi", - "description": "The API object provided to the `purchase.checkout.pickup-location-option-item.render-after` extension target.", - "type": "PickupLocationItemApi", - "typeDefinitions": { - "PickupLocationItemApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "name": "PickupLocationItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the pickup location is currently selected." - }, - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The pickup location the extension is attached to." - } - ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the pickup location is currently selected.\n */\n isTargetSelected: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - } - } - }, - { - "title": "usePickupLocationOptionTarget", - "description": "Returns the pickup location option for `purchase.checkout.pickup-location-option-item.render-after` attached extensions.", - "type": "UsePickupLocationOptionTargetGeneratedType", - "typeDefinitions": { - "UsePickupLocationOptionTargetGeneratedType": { - "filePath": "src/surfaces/checkout/preact/pickup-location-option-target.ts", - "name": "UsePickupLocationOptionTargetGeneratedType", - "description": "Returns the pickup location option the extension is attached to. This hook can only be used by extensions in the following extension target:\n- `purchase.checkout.pickup-location-option-item.render-after`", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/pickup-location-option-target.ts", - "description": "", - "name": "{\n pickupLocationOptionTarget: PickupLocationOption;\n isTargetSelected: boolean;\n}", - "value": "{\n pickupLocationOptionTarget: PickupLocationOption;\n isTargetSelected: boolean;\n}" - }, - "value": "export function usePickupLocationOptionTarget(): {\n pickupLocationOptionTarget: PickupLocationOption;\n isTargetSelected: boolean;\n} {\n const api =\n useApi<'purchase.checkout.pickup-location-option-item.render-after'>();\n if (!api.target || api.isTargetSelected === undefined) {\n throw new ExtensionHasNoTargetError(\n 'usePickupLocationOptionTarget',\n api.extension.target,\n );\n }\n\n const pickupLocationOptionTarget = useSubscription(api.target);\n const isTargetSelected = useSubscription(api.isTargetSelected);\n\n const pickupLocationOption = useMemo(() => {\n return {\n pickupLocationOptionTarget,\n isTargetSelected,\n };\n }, [pickupLocationOptionTarget, isTargetSelected]);\n\n return pickupLocationOption;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Delivery group", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useDeliveryGroup} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const firstDeliveryGroup = useDeliveryGroup(\n shopify.deliveryGroups.value[0],\n );\n\n if (!firstDeliveryGroup) {\n return null;\n }\n\n const selectedDeliveryOption =\n firstDeliveryGroup?.selectedDeliveryOption;\n\n return (\n <s-banner>\n Selected delivery option:{' '}\n {selectedDeliveryOption?.title}\n </s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "Learn how to use the API with JavaScript (JS) and React. See [React Hooks](../react-hooks) for all available hooks.", - "examples": [ - { - "description": "", - "codeblock": { - "title": "Reading the selected shipping option", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useShippingOptionTarget} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {shippingOptionTarget, isTargetSelected} =\n useShippingOptionTarget();\n const title = shippingOptionTarget.title;\n\n return (\n <s-text>\n Shipping method: {title} is{' '}\n {isTargetSelected ? '' : 'not'} selected.\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "", - "codeblock": { - "title": "Reading the selected pickup location option", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {usePickupLocationOptionTarget} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {\n isTargetSelected,\n pickupLocationOptionTarget,\n } = usePickupLocationOptionTarget();\n\n const title = pickupLocationOptionTarget?.title;\n\n if (isTargetSelected) {\n return <s-text>{title}</s-text>;\n }\n\n return null;\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "", - "codeblock": { - "title": "Determine if the location input form is shown", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (shopify.isLocationFormVisible.value) {\n return (\n <s-text>\n The customer is being asked to provide\n their location.\n </s-text>\n );\n } else {\n return (\n <s-text>\n Pickup points are being shown.\n </s-text>\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - { - "description": "", - "codeblock": { - "title": "Delivery groups", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const deliveryGroups =\n shopify.deliveryGroups.value;\n return (\n <s-banner>\n First delivery option:{' '}\n {deliveryGroups[0].deliveryOptions[0].title}\n </s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Discounts", - "description": "The API for interacting with discounts.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_DiscountsApi", - "typeDefinitions": { - "Docs_Standard_DiscountsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_DiscountsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - } - ], - "value": "export interface Docs_Standard_DiscountsApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_DiscountsApi", - "typeDefinitions": { - "Docs_Checkout_DiscountsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_DiscountsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - } - ], - "value": "export interface Docs_Checkout_DiscountsApi\n extends Pick {}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useApplyDiscountCodeChange", - "description": "Returns a function to add or remove discount codes.", - "type": "UseApplyDiscountCodeChangeGeneratedType", - "typeDefinitions": { - "UseApplyDiscountCodeChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/discounts.ts", - "name": "UseApplyDiscountCodeChangeGeneratedType", - "description": "Returns a function to add or remove discount codes.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/discounts.ts", - "description": "", - "name": "(change: DiscountCodeChange) => Promise", - "value": "(change: DiscountCodeChange) => Promise" - }, - "value": "export function useApplyDiscountCodeChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: DiscountCodeChange) => Promise {\n const api = useApi();\n\n if ('applyDiscountCodeChange' in api) {\n return api.applyDiscountCodeChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyDiscountCodeChange',\n api.extension.target,\n );\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useDiscountAllocations", - "description": "Returns the current discount allocations applied to the cart.", - "type": "UseDiscountAllocationsGeneratedType", - "typeDefinitions": { - "UseDiscountAllocationsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/discounts.ts", - "name": "UseDiscountAllocationsGeneratedType", - "description": "Returns the current discount allocations applied to the cart, and automatically re-renders your component if discount allocations changed.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/discounts.ts", - "description": "", - "name": "CartDiscountAllocation[]", - "value": "CartDiscountAllocation[]" - }, - "value": "export function useDiscountAllocations<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartDiscountAllocation[] {\n const {discountAllocations} = useApi();\n\n return useSubscription(discountAllocations);\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - } - } - }, - { - "title": "useDiscountCodes", - "description": "Returns the current discount codes applied to the cart.", - "type": "UseDiscountCodesGeneratedType", - "typeDefinitions": { - "UseDiscountCodesGeneratedType": { - "filePath": "src/surfaces/checkout/preact/discounts.ts", - "name": "UseDiscountCodesGeneratedType", - "description": "Returns the current discount codes applied to the cart, and automatically re-renders your component if discount codes are added or removed.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/discounts.ts", - "description": "", - "name": "CartDiscountCode[]", - "value": "CartDiscountCode[]" - }, - "value": "export function useDiscountCodes<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartDiscountCode[] {\n const {discountCodes} = useApi();\n\n return useSubscription(discountCodes);\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Extension", - "description": "The API for interacting with the metadata of an extension.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_ExtensionMetaApi", - "typeDefinitions": { - "Docs_Standard_ExtensionMetaApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_ExtensionMetaApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - } - ], - "value": "export interface Docs_Standard_ExtensionMetaApi\n extends Pick {}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - } - } - }, - { - "title": "useExtension", - "description": "Returns the metadata about the extension.", - "type": "UseExtensionGeneratedType", - "typeDefinitions": { - "UseExtensionGeneratedType": { - "filePath": "src/surfaces/checkout/preact/extension.ts", - "name": "UseExtensionGeneratedType", - "description": "Returns the metadata about the extension.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/extension.ts", - "description": "", - "name": "Extension", - "value": "Extension" - }, - "value": "export function useExtension(): Extension {\n return useApi().extension as Extension;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - } - } - }, - { - "title": "useExtensionData", - "description": "Returns the metadata about the extension. This is deprecated, use `useExtension()` instead.", - "type": "UseExtensionDataGeneratedType", - "typeDefinitions": { - "UseExtensionDataGeneratedType": { - "filePath": "src/surfaces/checkout/preact/extension.ts", - "name": "UseExtensionDataGeneratedType", - "description": "Returns the metadata about the extension. > Caution: This is deprecated, use `useExtension()` instead.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/extension.ts", - "description": "", - "name": "Extension", - "value": "Extension" - }, - "value": "export function useExtensionData(): Extension {\n return useExtension();\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - } - } - }, - { - "title": "useExtensionCapabilities", - "description": "Returns a list of an extension's granted capabilities.", - "type": "UseExtensionCapabilitiesGeneratedType", - "typeDefinitions": { - "UseExtensionCapabilitiesGeneratedType": { - "filePath": "src/surfaces/checkout/preact/capabilities.ts", - "name": "UseExtensionCapabilitiesGeneratedType", - "description": "Returns a list of an extension's granted capabilities.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/capabilities.ts", - "description": "", - "name": "Capability[]", - "value": "Capability[]" - }, - "value": "export function useExtensionCapabilities(): Capability[] {\n return useSubscription(useApi().extension.capabilities);\n}" - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - } - } - }, - { - "title": "useExtensionCapability", - "description": "Returns whether or not a given capability of an extension is granted.", - "type": "UseExtensionCapabilityGeneratedType", - "typeDefinitions": { - "UseExtensionCapabilityGeneratedType": { - "filePath": "src/surfaces/checkout/preact/capabilities.ts", - "name": "UseExtensionCapabilityGeneratedType", - "description": "Returns whether or not a given capability of an extension is granted.", - "params": [ - { - "name": "capability", - "description": "", - "value": "Capability", - "filePath": "src/surfaces/checkout/preact/capabilities.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/capabilities.ts", - "description": "", - "name": "boolean", - "value": "boolean" - }, - "value": "export function useExtensionCapability(capability: Capability): boolean {\n return useExtensionCapabilities().includes(capability);\n}" - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - } - } - }, - { - "title": "useExtensionEditor", - "description": "Returns information about the editor where the extension is being rendered.", - "type": "UseExtensionEditorGeneratedType", - "typeDefinitions": { - "UseExtensionEditorGeneratedType": { - "filePath": "src/surfaces/checkout/preact/extension-editor.ts", - "name": "UseExtensionEditorGeneratedType", - "description": "Returns information about the editor where the extension is being rendered.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/extension-editor.ts", - "description": "", - "name": "Editor | undefined", - "value": "Editor | undefined" - }, - "value": "export function useExtensionEditor(): Editor | undefined {\n return useApi().extension.editor;\n}" - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Gift Cards", - "description": "The API for interacting with gift cards.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_GiftCardsApi", - "typeDefinitions": { - "Docs_Standard_GiftCardsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_GiftCardsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - } - ], - "value": "export interface Docs_Standard_GiftCardsApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_GiftCardsApi", - "typeDefinitions": { - "Docs_Checkout_GiftCardsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_GiftCardsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - } - ], - "value": "export interface Docs_Checkout_GiftCardsApi\n extends Pick {}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useAppliedGiftCards", - "description": "Returns the current gift cards applied to the cart.", - "type": "UseAppliedGiftCardsGeneratedType", - "typeDefinitions": { - "UseAppliedGiftCardsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/gift-cards.ts", - "name": "UseAppliedGiftCardsGeneratedType", - "description": "Returns the current gift cards applied to the cart, and automatically re-renders your component if gift cards are added or removed.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/gift-cards.ts", - "description": "", - "name": "AppliedGiftCard[]", - "value": "AppliedGiftCard[]" - }, - "value": "export function useAppliedGiftCards<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): AppliedGiftCard[] {\n const {appliedGiftCards} = useApi();\n\n return useSubscription(appliedGiftCards);\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useApplyGiftCardChange", - "description": "Returns a function to add or remove gift cards.", - "type": "UseApplyGiftCardChangeGeneratedType", - "typeDefinitions": { - "UseApplyGiftCardChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/gift-cards.ts", - "name": "UseApplyGiftCardChangeGeneratedType", - "description": "Returns a function to add or remove gift cards.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/gift-cards.ts", - "description": "", - "name": "(change: GiftCardChange) => Promise", - "value": "(change: GiftCardChange) => Promise" - }, - "value": "export function useApplyGiftCardChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: GiftCardChange) => Promise {\n const api = useApi();\n\n if ('applyGiftCardChange' in api) {\n return api.applyGiftCardChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyGiftCardChange',\n api.extension.target,\n );\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Localization", - "description": "The APIs for localizing your extension.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_LocalizationApi", - "typeDefinitions": { - "Docs_Standard_LocalizationApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_LocalizationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - } - ], - "value": "export interface Docs_Standard_LocalizationApi\n extends Pick {}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - } - } - }, - { - "title": "useCurrency", - "description": "Returns the currency of the checkout.", - "type": "UseCurrencyGeneratedType", - "typeDefinitions": { - "UseCurrencyGeneratedType": { - "filePath": "src/surfaces/checkout/preact/currency.ts", - "name": "UseCurrencyGeneratedType", - "description": "Returns the currency of the checkout, and automatically re-renders your component if the currency changes.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/currency.ts", - "description": "", - "name": "Currency", - "value": "Currency" - }, - "value": "export function useCurrency<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Currency {\n const {localization} = useApi();\n\n return useSubscription(localization.currency);\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - } - } - }, - { - "title": "useExtensionLanguage", - "description": "Returns the buyer's language, as supported by the extension.", - "type": "UseExtensionLanguageGeneratedType", - "typeDefinitions": { - "UseExtensionLanguageGeneratedType": { - "filePath": "src/surfaces/checkout/preact/extension-language.ts", - "name": "UseExtensionLanguageGeneratedType", - "description": "Returns the buyer's language, as supported by the extension.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/extension-language.ts", - "description": "", - "name": "Language", - "value": "Language" - }, - "value": "export function useExtensionLanguage<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Language {\n const {localization} = useApi();\n\n return useSubscription(localization.extensionLanguage);\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - } - } - }, - { - "title": "useLanguage", - "description": "Returns the current language of the checkout, and automatically re-renders your component if the language changes.", - "type": "UseLanguageGeneratedType", - "typeDefinitions": { - "UseLanguageGeneratedType": { - "filePath": "src/surfaces/checkout/preact/language.ts", - "name": "UseLanguageGeneratedType", - "description": "Returns the current language of the checkout, and automatically re-renders your component if the language changes.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/language.ts", - "description": "", - "name": "Language", - "value": "Language" - }, - "value": "export function useLanguage<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Language {\n const {localization} = useApi();\n\n return useSubscription(localization.language);\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - } - } - }, - { - "title": "useLocalizationCountry", - "description": "Returns the country of the checkout, and automatically re-renders your component if the country changes.", - "type": "UseLocalizationCountryGeneratedType", - "typeDefinitions": { - "UseLocalizationCountryGeneratedType": { - "filePath": "src/surfaces/checkout/preact/country.ts", - "name": "UseLocalizationCountryGeneratedType", - "description": "Returns the country of the checkout, and automatically re-renders your component if the country changes.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/country.ts", - "description": "", - "name": "Country | undefined", - "value": "Country | undefined" - }, - "value": "export function useLocalizationCountry<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Country | undefined {\n const {localization} = useApi();\n\n return useSubscription(localization.country);\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - } - } - }, - { - "title": "useLocalizationMarket", - "description": "Returns the market of the checkout, and automatically re-renders your component if it changes.", - "type": "UseLocalizationMarketGeneratedType", - "typeDefinitions": { - "UseLocalizationMarketGeneratedType": { - "filePath": "src/surfaces/checkout/preact/market.ts", - "name": "UseLocalizationMarketGeneratedType", - "description": "Returns the market of the checkout, and automatically re-renders your component if it changes.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/market.ts", - "description": "", - "name": "Market | undefined", - "value": "Market | undefined" - }, - "value": "export function useLocalizationMarket<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Market | undefined {\n const {localization} = useApi();\n\n return useSubscription(localization.market);\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - } - } - }, - { - "title": "useTimezone", - "description": "Returns the time zone of the checkout, and automatically re-renders your component if the time zone changes.", - "type": "UseTimezoneGeneratedType", - "typeDefinitions": { - "UseTimezoneGeneratedType": { - "filePath": "src/surfaces/checkout/preact/timezone.ts", - "name": "UseTimezoneGeneratedType", - "description": "Returns the time zone of the checkout, and automatically re-renders your component if the time zone changes.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/timezone.ts", - "description": "", - "name": "\"Africa/Abidjan\" | \"Africa/Algiers\" | \"Africa/Bissau\" | \"Africa/Cairo\" | \"Africa/Casablanca\" | \"Africa/Ceuta\" | \"Africa/El_Aaiun\" | \"Africa/Johannesburg\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Lagos\" | \"Africa/Maputo\" | \"Africa/Monrovia\" | \"Africa/Nairobi\" | \"Africa/Ndjamena\" | \"Africa/Sao_Tome\" | \"Africa/Tripoli\" | \"Africa/Tunis\" | \"Africa/Windhoek\" | \"America/Adak\" | \"America/Anchorage\" | \"America/Araguaina\" | \"America/Argentina/Buenos_Aires\" | \"America/Argentina/Catamarca\" | \"America/Argentina/Cordoba\" | \"America/Argentina/Jujuy\" | \"America/Argentina/La_Rioja\" | \"America/Argentina/Mendoza\" | \"America/Argentina/Rio_Gallegos\" | \"America/Argentina/Salta\" | \"America/Argentina/San_Juan\" | \"America/Argentina/San_Luis\" | \"America/Argentina/Tucuman\" | \"America/Argentina/Ushuaia\" | \"America/Asuncion\" | \"America/Bahia\" | \"America/Bahia_Banderas\" | \"America/Barbados\" | \"America/Belem\" | \"America/Belize\" | \"America/Boa_Vista\" | \"America/Bogota\" | \"America/Boise\" | \"America/Cambridge_Bay\" | \"America/Campo_Grande\" | \"America/Cancun\" | \"America/Caracas\" | \"America/Cayenne\" | \"America/Chicago\" | \"America/Chihuahua\" | \"America/Costa_Rica\" | \"America/Cuiaba\" | \"America/Danmarkshavn\" | \"America/Dawson\" | \"America/Dawson_Creek\" | \"America/Denver\" | \"America/Detroit\" | \"America/Edmonton\" | \"America/Eirunepe\" | \"America/El_Salvador\" | \"America/Fort_Nelson\" | \"America/Fortaleza\" | \"America/Glace_Bay\" | \"America/Goose_Bay\" | \"America/Grand_Turk\" | \"America/Guatemala\" | \"America/Guayaquil\" | \"America/Guyana\" | \"America/Halifax\" | \"America/Havana\" | \"America/Hermosillo\" | \"America/Indiana/Indianapolis\" | \"America/Indiana/Knox\" | \"America/Indiana/Marengo\" | \"America/Indiana/Petersburg\" | \"America/Indiana/Tell_City\" | \"America/Indiana/Vevay\" | \"America/Indiana/Vincennes\" | \"America/Indiana/Winamac\" | \"America/Inuvik\" | \"America/Iqaluit\" | \"America/Jamaica\" | \"America/Juneau\" | \"America/Kentucky/Louisville\" | \"America/Kentucky/Monticello\" | \"America/La_Paz\" | \"America/Lima\" | \"America/Los_Angeles\" | \"America/Maceio\" | \"America/Managua\" | \"America/Manaus\" | \"America/Martinique\" | \"America/Matamoros\" | \"America/Mazatlan\" | \"America/Menominee\" | \"America/Merida\" | \"America/Metlakatla\" | \"America/Mexico_City\" | \"America/Miquelon\" | \"America/Moncton\" | \"America/Monterrey\" | \"America/Montevideo\" | \"America/New_York\" | \"America/Nipigon\" | \"America/Nome\" | \"America/Noronha\" | \"America/North_Dakota/Beulah\" | \"America/North_Dakota/Center\" | \"America/North_Dakota/New_Salem\" | \"America/Nuuk\" | \"America/Ojinaga\" | \"America/Panama\" | \"America/Pangnirtung\" | \"America/Paramaribo\" | \"America/Phoenix\" | \"America/Port-au-Prince\" | \"America/Porto_Velho\" | \"America/Puerto_Rico\" | \"America/Punta_Arenas\" | \"America/Rainy_River\" | \"America/Rankin_Inlet\" | \"America/Recife\" | \"America/Regina\" | \"America/Resolute\" | \"America/Rio_Branco\" | \"America/Santarem\" | \"America/Santiago\" | \"America/Santo_Domingo\" | \"America/Sao_Paulo\" | \"America/Scoresbysund\" | \"America/Sitka\" | \"America/St_Johns\" | \"America/Swift_Current\" | \"America/Tegucigalpa\" | \"America/Thule\" | \"America/Thunder_Bay\" | \"America/Tijuana\" | \"America/Toronto\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Winnipeg\" | \"America/Yakutat\" | \"America/Yellowknife\" | \"Antarctica/Casey\" | \"Antarctica/Davis\" | \"Antarctica/Macquarie\" | \"Antarctica/Mawson\" | \"Antarctica/Palmer\" | \"Antarctica/Rothera\" | \"Antarctica/Troll\" | \"Antarctica/Vostok\" | \"Asia/Almaty\" | \"Asia/Amman\" | \"Asia/Anadyr\" | \"Asia/Aqtau\" | \"Asia/Aqtobe\" | \"Asia/Ashgabat\" | \"Asia/Atyrau\" | \"Asia/Baghdad\" | \"Asia/Baku\" | \"Asia/Bangkok\" | \"Asia/Barnaul\" | \"Asia/Beirut\" | \"Asia/Bishkek\" | \"Asia/Brunei\" | \"Asia/Chita\" | \"Asia/Choibalsan\" | \"Asia/Colombo\" | \"Asia/Damascus\" | \"Asia/Dhaka\" | \"Asia/Dili\" | \"Asia/Dubai\" | \"Asia/Dushanbe\" | \"Asia/Famagusta\" | \"Asia/Gaza\" | \"Asia/Hebron\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Hong_Kong\" | \"Asia/Hovd\" | \"Asia/Irkutsk\" | \"Asia/Jakarta\" | \"Asia/Jayapura\" | \"Asia/Jerusalem\" | \"Asia/Kabul\" | \"Asia/Kamchatka\" | \"Asia/Karachi\" | \"Asia/Kathmandu\" | \"Asia/Khandyga\" | \"Asia/Kolkata\" | \"Asia/Krasnoyarsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Kuching\" | \"Asia/Macau\" | \"Asia/Magadan\" | \"Asia/Makassar\" | \"Asia/Manila\" | \"Asia/Nicosia\" | \"Asia/Novokuznetsk\" | \"Asia/Novosibirsk\" | \"Asia/Omsk\" | \"Asia/Oral\" | \"Asia/Pontianak\" | \"Asia/Pyongyang\" | \"Asia/Qatar\" | \"Asia/Qostanay\" | \"Asia/Qyzylorda\" | \"Asia/Riyadh\" | \"Asia/Sakhalin\" | \"Asia/Samarkand\" | \"Asia/Seoul\" | \"Asia/Shanghai\" | \"Asia/Singapore\" | \"Asia/Srednekolymsk\" | \"Asia/Taipei\" | \"Asia/Tashkent\" | \"Asia/Tbilisi\" | \"Asia/Tehran\" | \"Asia/Thimphu\" | \"Asia/Tokyo\" | \"Asia/Tomsk\" | \"Asia/Ulaanbaatar\" | \"Asia/Urumqi\" | \"Asia/Ust-Nera\" | \"Asia/Vladivostok\" | \"Asia/Yakutsk\" | \"Asia/Yangon\" | \"Asia/Yekaterinburg\" | \"Asia/Yerevan\" | \"Atlantic/Azores\" | \"Atlantic/Bermuda\" | \"Atlantic/Canary\" | \"Atlantic/Cape_Verde\" | \"Atlantic/Faroe\" | \"Atlantic/Madeira\" | \"Atlantic/Reykjavik\" | \"Atlantic/South_Georgia\" | \"Atlantic/Stanley\" | \"Australia/Adelaide\" | \"Australia/Brisbane\" | \"Australia/Broken_Hill\" | \"Australia/Darwin\" | \"Australia/Eucla\" | \"Australia/Hobart\" | \"Australia/Lindeman\" | \"Australia/Lord_Howe\" | \"Australia/Melbourne\" | \"Australia/Perth\" | \"Australia/Sydney\" | \"CET\" | \"CST6CDT\" | \"EET\" | \"EST\" | \"EST5EDT\" | \"Etc/GMT\" | \"Etc/GMT-1\" | \"Etc/GMT-10\" | \"Etc/GMT-11\" | \"Etc/GMT-12\" | \"Etc/GMT-13\" | \"Etc/GMT-14\" | \"Etc/GMT-2\" | \"Etc/GMT-3\" | \"Etc/GMT-4\" | \"Etc/GMT-5\" | \"Etc/GMT-6\" | \"Etc/GMT-7\" | \"Etc/GMT-8\" | \"Etc/GMT-9\" | \"Etc/GMT+1\" | \"Etc/GMT+10\" | \"Etc/GMT+11\" | \"Etc/GMT+12\" | \"Etc/GMT+2\" | \"Etc/GMT+3\" | \"Etc/GMT+4\" | \"Etc/GMT+5\" | \"Etc/GMT+6\" | \"Etc/GMT+7\" | \"Etc/GMT+8\" | \"Etc/GMT+9\" | \"Etc/UTC\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Astrakhan\" | \"Europe/Athens\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Brussels\" | \"Europe/Bucharest\" | \"Europe/Budapest\" | \"Europe/Chisinau\" | \"Europe/Copenhagen\" | \"Europe/Dublin\" | \"Europe/Gibraltar\" | \"Europe/Helsinki\" | \"Europe/Istanbul\" | \"Europe/Kaliningrad\" | \"Europe/Kiev\" | \"Europe/Kirov\" | \"Europe/Lisbon\" | \"Europe/London\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Malta\" | \"Europe/Minsk\" | \"Europe/Monaco\" | \"Europe/Moscow\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Prague\" | \"Europe/Riga\" | \"Europe/Rome\" | \"Europe/Samara\" | \"Europe/Saratov\" | \"Europe/Simferopol\" | \"Europe/Sofia\" | \"Europe/Stockholm\" | \"Europe/Tallinn\" | \"Europe/Tirane\" | \"Europe/Ulyanovsk\" | \"Europe/Uzhgorod\" | \"Europe/Vienna\" | \"Europe/Vilnius\" | \"Europe/Volgograd\" | \"Europe/Warsaw\" | \"Europe/Zaporozhye\" | \"Europe/Zurich\" | \"HST\" | \"Indian/Chagos\" | \"Indian/Christmas\" | \"Indian/Cocos\" | \"Indian/Kerguelen\" | \"Indian/Mahe\" | \"Indian/Maldives\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"MET\" | \"MST\" | \"MST7MDT\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Pacific/Bougainville\" | \"Pacific/Chatham\" | \"Pacific/Chuuk\" | \"Pacific/Easter\" | \"Pacific/Efate\" | \"Pacific/Fakaofo\" | \"Pacific/Fiji\" | \"Pacific/Funafuti\" | \"Pacific/Galapagos\" | \"Pacific/Gambier\" | \"Pacific/Guadalcanal\" | \"Pacific/Guam\" | \"Pacific/Honolulu\" | \"Pacific/Kanton\" | \"Pacific/Kiritimati\" | \"Pacific/Kosrae\" | \"Pacific/Kwajalein\" | \"Pacific/Majuro\" | \"Pacific/Marquesas\" | \"Pacific/Nauru\" | \"Pacific/Niue\" | \"Pacific/Norfolk\" | \"Pacific/Noumea\" | \"Pacific/Pago_Pago\" | \"Pacific/Palau\" | \"Pacific/Pitcairn\" | \"Pacific/Pohnpei\" | \"Pacific/Port_Moresby\" | \"Pacific/Rarotonga\" | \"Pacific/Tahiti\" | \"Pacific/Tarawa\" | \"Pacific/Tongatapu\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"PST8PDT\" | \"WET\"", - "value": "\"Africa/Abidjan\" | \"Africa/Algiers\" | \"Africa/Bissau\" | \"Africa/Cairo\" | \"Africa/Casablanca\" | \"Africa/Ceuta\" | \"Africa/El_Aaiun\" | \"Africa/Johannesburg\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Lagos\" | \"Africa/Maputo\" | \"Africa/Monrovia\" | \"Africa/Nairobi\" | \"Africa/Ndjamena\" | \"Africa/Sao_Tome\" | \"Africa/Tripoli\" | \"Africa/Tunis\" | \"Africa/Windhoek\" | \"America/Adak\" | \"America/Anchorage\" | \"America/Araguaina\" | \"America/Argentina/Buenos_Aires\" | \"America/Argentina/Catamarca\" | \"America/Argentina/Cordoba\" | \"America/Argentina/Jujuy\" | \"America/Argentina/La_Rioja\" | \"America/Argentina/Mendoza\" | \"America/Argentina/Rio_Gallegos\" | \"America/Argentina/Salta\" | \"America/Argentina/San_Juan\" | \"America/Argentina/San_Luis\" | \"America/Argentina/Tucuman\" | \"America/Argentina/Ushuaia\" | \"America/Asuncion\" | \"America/Bahia\" | \"America/Bahia_Banderas\" | \"America/Barbados\" | \"America/Belem\" | \"America/Belize\" | \"America/Boa_Vista\" | \"America/Bogota\" | \"America/Boise\" | \"America/Cambridge_Bay\" | \"America/Campo_Grande\" | \"America/Cancun\" | \"America/Caracas\" | \"America/Cayenne\" | \"America/Chicago\" | \"America/Chihuahua\" | \"America/Costa_Rica\" | \"America/Cuiaba\" | \"America/Danmarkshavn\" | \"America/Dawson\" | \"America/Dawson_Creek\" | \"America/Denver\" | \"America/Detroit\" | \"America/Edmonton\" | \"America/Eirunepe\" | \"America/El_Salvador\" | \"America/Fort_Nelson\" | \"America/Fortaleza\" | \"America/Glace_Bay\" | \"America/Goose_Bay\" | \"America/Grand_Turk\" | \"America/Guatemala\" | \"America/Guayaquil\" | \"America/Guyana\" | \"America/Halifax\" | \"America/Havana\" | \"America/Hermosillo\" | \"America/Indiana/Indianapolis\" | \"America/Indiana/Knox\" | \"America/Indiana/Marengo\" | \"America/Indiana/Petersburg\" | \"America/Indiana/Tell_City\" | \"America/Indiana/Vevay\" | \"America/Indiana/Vincennes\" | \"America/Indiana/Winamac\" | \"America/Inuvik\" | \"America/Iqaluit\" | \"America/Jamaica\" | \"America/Juneau\" | \"America/Kentucky/Louisville\" | \"America/Kentucky/Monticello\" | \"America/La_Paz\" | \"America/Lima\" | \"America/Los_Angeles\" | \"America/Maceio\" | \"America/Managua\" | \"America/Manaus\" | \"America/Martinique\" | \"America/Matamoros\" | \"America/Mazatlan\" | \"America/Menominee\" | \"America/Merida\" | \"America/Metlakatla\" | \"America/Mexico_City\" | \"America/Miquelon\" | \"America/Moncton\" | \"America/Monterrey\" | \"America/Montevideo\" | \"America/New_York\" | \"America/Nipigon\" | \"America/Nome\" | \"America/Noronha\" | \"America/North_Dakota/Beulah\" | \"America/North_Dakota/Center\" | \"America/North_Dakota/New_Salem\" | \"America/Nuuk\" | \"America/Ojinaga\" | \"America/Panama\" | \"America/Pangnirtung\" | \"America/Paramaribo\" | \"America/Phoenix\" | \"America/Port-au-Prince\" | \"America/Porto_Velho\" | \"America/Puerto_Rico\" | \"America/Punta_Arenas\" | \"America/Rainy_River\" | \"America/Rankin_Inlet\" | \"America/Recife\" | \"America/Regina\" | \"America/Resolute\" | \"America/Rio_Branco\" | \"America/Santarem\" | \"America/Santiago\" | \"America/Santo_Domingo\" | \"America/Sao_Paulo\" | \"America/Scoresbysund\" | \"America/Sitka\" | \"America/St_Johns\" | \"America/Swift_Current\" | \"America/Tegucigalpa\" | \"America/Thule\" | \"America/Thunder_Bay\" | \"America/Tijuana\" | \"America/Toronto\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Winnipeg\" | \"America/Yakutat\" | \"America/Yellowknife\" | \"Antarctica/Casey\" | \"Antarctica/Davis\" | \"Antarctica/Macquarie\" | \"Antarctica/Mawson\" | \"Antarctica/Palmer\" | \"Antarctica/Rothera\" | \"Antarctica/Troll\" | \"Antarctica/Vostok\" | \"Asia/Almaty\" | \"Asia/Amman\" | \"Asia/Anadyr\" | \"Asia/Aqtau\" | \"Asia/Aqtobe\" | \"Asia/Ashgabat\" | \"Asia/Atyrau\" | \"Asia/Baghdad\" | \"Asia/Baku\" | \"Asia/Bangkok\" | \"Asia/Barnaul\" | \"Asia/Beirut\" | \"Asia/Bishkek\" | \"Asia/Brunei\" | \"Asia/Chita\" | \"Asia/Choibalsan\" | \"Asia/Colombo\" | \"Asia/Damascus\" | \"Asia/Dhaka\" | \"Asia/Dili\" | \"Asia/Dubai\" | \"Asia/Dushanbe\" | \"Asia/Famagusta\" | \"Asia/Gaza\" | \"Asia/Hebron\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Hong_Kong\" | \"Asia/Hovd\" | \"Asia/Irkutsk\" | \"Asia/Jakarta\" | \"Asia/Jayapura\" | \"Asia/Jerusalem\" | \"Asia/Kabul\" | \"Asia/Kamchatka\" | \"Asia/Karachi\" | \"Asia/Kathmandu\" | \"Asia/Khandyga\" | \"Asia/Kolkata\" | \"Asia/Krasnoyarsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Kuching\" | \"Asia/Macau\" | \"Asia/Magadan\" | \"Asia/Makassar\" | \"Asia/Manila\" | \"Asia/Nicosia\" | \"Asia/Novokuznetsk\" | \"Asia/Novosibirsk\" | \"Asia/Omsk\" | \"Asia/Oral\" | \"Asia/Pontianak\" | \"Asia/Pyongyang\" | \"Asia/Qatar\" | \"Asia/Qostanay\" | \"Asia/Qyzylorda\" | \"Asia/Riyadh\" | \"Asia/Sakhalin\" | \"Asia/Samarkand\" | \"Asia/Seoul\" | \"Asia/Shanghai\" | \"Asia/Singapore\" | \"Asia/Srednekolymsk\" | \"Asia/Taipei\" | \"Asia/Tashkent\" | \"Asia/Tbilisi\" | \"Asia/Tehran\" | \"Asia/Thimphu\" | \"Asia/Tokyo\" | \"Asia/Tomsk\" | \"Asia/Ulaanbaatar\" | \"Asia/Urumqi\" | \"Asia/Ust-Nera\" | \"Asia/Vladivostok\" | \"Asia/Yakutsk\" | \"Asia/Yangon\" | \"Asia/Yekaterinburg\" | \"Asia/Yerevan\" | \"Atlantic/Azores\" | \"Atlantic/Bermuda\" | \"Atlantic/Canary\" | \"Atlantic/Cape_Verde\" | \"Atlantic/Faroe\" | \"Atlantic/Madeira\" | \"Atlantic/Reykjavik\" | \"Atlantic/South_Georgia\" | \"Atlantic/Stanley\" | \"Australia/Adelaide\" | \"Australia/Brisbane\" | \"Australia/Broken_Hill\" | \"Australia/Darwin\" | \"Australia/Eucla\" | \"Australia/Hobart\" | \"Australia/Lindeman\" | \"Australia/Lord_Howe\" | \"Australia/Melbourne\" | \"Australia/Perth\" | \"Australia/Sydney\" | \"CET\" | \"CST6CDT\" | \"EET\" | \"EST\" | \"EST5EDT\" | \"Etc/GMT\" | \"Etc/GMT-1\" | \"Etc/GMT-10\" | \"Etc/GMT-11\" | \"Etc/GMT-12\" | \"Etc/GMT-13\" | \"Etc/GMT-14\" | \"Etc/GMT-2\" | \"Etc/GMT-3\" | \"Etc/GMT-4\" | \"Etc/GMT-5\" | \"Etc/GMT-6\" | \"Etc/GMT-7\" | \"Etc/GMT-8\" | \"Etc/GMT-9\" | \"Etc/GMT+1\" | \"Etc/GMT+10\" | \"Etc/GMT+11\" | \"Etc/GMT+12\" | \"Etc/GMT+2\" | \"Etc/GMT+3\" | \"Etc/GMT+4\" | \"Etc/GMT+5\" | \"Etc/GMT+6\" | \"Etc/GMT+7\" | \"Etc/GMT+8\" | \"Etc/GMT+9\" | \"Etc/UTC\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Astrakhan\" | \"Europe/Athens\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Brussels\" | \"Europe/Bucharest\" | \"Europe/Budapest\" | \"Europe/Chisinau\" | \"Europe/Copenhagen\" | \"Europe/Dublin\" | \"Europe/Gibraltar\" | \"Europe/Helsinki\" | \"Europe/Istanbul\" | \"Europe/Kaliningrad\" | \"Europe/Kiev\" | \"Europe/Kirov\" | \"Europe/Lisbon\" | \"Europe/London\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Malta\" | \"Europe/Minsk\" | \"Europe/Monaco\" | \"Europe/Moscow\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Prague\" | \"Europe/Riga\" | \"Europe/Rome\" | \"Europe/Samara\" | \"Europe/Saratov\" | \"Europe/Simferopol\" | \"Europe/Sofia\" | \"Europe/Stockholm\" | \"Europe/Tallinn\" | \"Europe/Tirane\" | \"Europe/Ulyanovsk\" | \"Europe/Uzhgorod\" | \"Europe/Vienna\" | \"Europe/Vilnius\" | \"Europe/Volgograd\" | \"Europe/Warsaw\" | \"Europe/Zaporozhye\" | \"Europe/Zurich\" | \"HST\" | \"Indian/Chagos\" | \"Indian/Christmas\" | \"Indian/Cocos\" | \"Indian/Kerguelen\" | \"Indian/Mahe\" | \"Indian/Maldives\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"MET\" | \"MST\" | \"MST7MDT\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Pacific/Bougainville\" | \"Pacific/Chatham\" | \"Pacific/Chuuk\" | \"Pacific/Easter\" | \"Pacific/Efate\" | \"Pacific/Fakaofo\" | \"Pacific/Fiji\" | \"Pacific/Funafuti\" | \"Pacific/Galapagos\" | \"Pacific/Gambier\" | \"Pacific/Guadalcanal\" | \"Pacific/Guam\" | \"Pacific/Honolulu\" | \"Pacific/Kanton\" | \"Pacific/Kiritimati\" | \"Pacific/Kosrae\" | \"Pacific/Kwajalein\" | \"Pacific/Majuro\" | \"Pacific/Marquesas\" | \"Pacific/Nauru\" | \"Pacific/Niue\" | \"Pacific/Norfolk\" | \"Pacific/Noumea\" | \"Pacific/Pago_Pago\" | \"Pacific/Palau\" | \"Pacific/Pitcairn\" | \"Pacific/Pohnpei\" | \"Pacific/Port_Moresby\" | \"Pacific/Rarotonga\" | \"Pacific/Tahiti\" | \"Pacific/Tarawa\" | \"Pacific/Tongatapu\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"PST8PDT\" | \"WET\"" - }, - "value": "export function useTimezone<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Timezone {\n const {localization} = useApi();\n\n return useSubscription(localization.timezone);\n}" - } - } - }, - { - "title": "useTranslate", - "description": "Returns the `I18nTranslate` interface used to translate strings.", - "type": "UseTranslateGeneratedType", - "typeDefinitions": { - "UseTranslateGeneratedType": { - "filePath": "src/surfaces/checkout/preact/translate.ts", - "name": "UseTranslateGeneratedType", - "description": "Returns the `I18nTranslate` interface used to translate strings.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/translate.ts", - "description": "", - "name": "I18nTranslate", - "value": "I18nTranslate" - }, - "value": "export function useTranslate<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): I18nTranslate {\n const api = useApi();\n return api.i18n.translate.bind(api.i18n);\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - } - } - } - ], - "defaultExample": { - "description": "\nDefine strings in JSON files for each locale and render them using `translate()`.\nSee [localizing UI extensions](/docs/apps/checkout/best-practices/localizing-ui-extensions) for more information.\n ", - "codeblock": { - "title": "Translating strings", - "tabs": [ - { - "code": "/* See the locales/en.default.json tab for the translation keys and values for this example */\nimport '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-text>\n {shopify.i18n.translate('welcomeMessage')}\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - }, - { - "code": "{\n \"welcomeMessage\": \"Welcome to our store!\"\n}\n", - "language": "json", - "title": "locales/en.default.json" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "\nYou can use the `count` option to get a pluralized string based on the current locale.\nSee [localizing UI extensions](/docs/apps/checkout/best-practices/localizing-ui-extensions) for more information.\n ", - "codeblock": { - "title": "Translating strings with pluralization", - "tabs": [ - { - "code": "/* See the locales/en.default.json tab for the translation keys and values for this example */\nimport '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const points = 10000;\n const formattedPoints =\n shopify.i18n.formatNumber(points);\n // Translate the loyalty points message, using pluralization to differentiate messages\n const loyaltyPointsMsg = shopify.i18n.translate(\n 'loyaltyPoints',\n {\n count: points,\n formattedPoints,\n },\n );\n\n return <s-banner>{loyaltyPointsMsg}</s-banner>;\n}\n", - "language": "jsx", - "title": "Preact" - }, - { - "code": "{\n \"loyaltyPoints\": {\n \"one\": \"You have {{formattedPoints}} loyalty point\",\n \"other\": \"You have {{formattedPoints}} loyalty points\"\n }\n}\n", - "language": "json", - "title": "locales/en.default.json" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Localized Fields", - "description": "The API for interacting with localized fields.", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_LocalizedFieldsApi", - "typeDefinitions": { - "Docs_Standard_LocalizedFieldsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_LocalizedFieldsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - } - ], - "value": "export interface Docs_Standard_LocalizedFieldsApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - } - } - }, - { - "title": "useLocalizedFields", - "description": "Returns the current localized fields and re-renders your component if the values change.", - "type": "UseLocalizedFieldsGeneratedType", - "typeDefinitions": { - "UseLocalizedFieldsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/localized-fields.ts", - "name": "UseLocalizedFieldsGeneratedType", - "description": "Returns the current localized fields and re-renders your component if the values change.", - "params": [ - { - "name": "keys", - "description": "", - "value": "LocalizedFieldKey[]", - "isOptional": true, - "filePath": "src/surfaces/checkout/preact/localized-fields.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/localized-fields.ts", - "description": "", - "name": "LocalizedField[]", - "value": "LocalizedField[]" - }, - "value": "export function useLocalizedFields<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(keys?: LocalizedFieldKey[]): LocalizedField[] {\n const {localizedFields} = useApi();\n\n if (!localizedFields) {\n throw new ScopeNotGrantedError(\n 'Using localized fields requires having personal customer data permissions granted to your app.',\n );\n }\n\n const localizedFieldsData = useSubscription(localizedFields);\n\n if (!keys) {\n return localizedFieldsData;\n }\n\n if (!keys.length) {\n return [];\n }\n\n return localizedFieldsData.filter(({key}) => keys.includes(key));\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - } - } - }, - { - "title": "useLocalizedField", - "description": "Returns the requested localized field and re-renders your component if the value changes.", - "type": "UseLocalizedFieldGeneratedType", - "typeDefinitions": { - "UseLocalizedFieldGeneratedType": { - "filePath": "src/surfaces/checkout/preact/localized-fields.ts", - "name": "UseLocalizedFieldGeneratedType", - "description": "Returns the current localized field or undefined for the specified localized field key and re-renders your component if the value changes.", - "params": [ - { - "name": "key", - "description": "", - "value": "LocalizedFieldKey", - "filePath": "src/surfaces/checkout/preact/localized-fields.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/localized-fields.ts", - "description": "", - "name": "LocalizedField | undefined", - "value": "LocalizedField | undefined" - }, - "value": "export function useLocalizedField<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(key: LocalizedFieldKey): LocalizedField | undefined {\n const fields = useLocalizedFields([key]);\n return fields[0];\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Read localized fields", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {\n useBuyerJourneyIntercept,\n useLocalizedField,\n} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n // 1. Access localized field\n const taxIdField = useLocalizedField(\n 'TAX_CREDENTIAL_BR',\n );\n\n // 2. Validate localized field value\n useBuyerJourneyIntercept(\n ({canBlockProgress}) => {\n return canBlockProgress &&\n taxIdField &&\n (!taxIdField.value ||\n taxIdField.value.length > 10)\n ? {\n behavior: 'block',\n reason: 'Invalid tax ID',\n errors: [\n {\n message: `${taxIdField.title} is required and\n cannot exceed 10 characters in length`,\n // Show an error under the field\n target: `$.cart.localizedField.${taxIdField.key}`,\n },\n ],\n }\n : {\n behavior: 'allow',\n };\n },\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Metafields", - "description": "The API for interacting with metafields.", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_MetafieldsApi", - "typeDefinitions": { - "Docs_Standard_MetafieldsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_MetafieldsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Docs_Standard_MetafieldsApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - } - } - }, - { - "title": "useAppMetafields", - "description": "Returns the metafields configured with `shopify.extension.toml`.", - "type": "UseAppMetafieldsGeneratedType", - "typeDefinitions": { - "UseAppMetafieldsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "name": "UseAppMetafieldsGeneratedType", - "description": "Returns the metafields configured with `shopify.extension.toml`.", - "params": [ - { - "name": "filters", - "description": "", - "value": "AppMetafieldFilters", - "isOptional": true, - "defaultValue": "{}", - "filePath": "src/surfaces/checkout/preact/app-metafields.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "description": "", - "name": "AppMetafieldEntry[]", - "value": "AppMetafieldEntry[]" - }, - "value": "export function useAppMetafields<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(filters: AppMetafieldFilters = {}): AppMetafieldEntry[] {\n const appMetafields = useSubscription(useApi().appMetafields);\n\n return useMemo(() => {\n if (filters.key && !filters.namespace) {\n throw new CheckoutUIExtensionError(\n 'You must pass in a namespace with a key',\n );\n }\n\n const filterKeys = Object.keys(filters) as AppMetafieldFilterKeys[];\n\n if (filterKeys.length) {\n return appMetafields.filter((app) => {\n return filterKeys.every((key) => {\n if (key === 'id' || key === 'type') {\n return app.target[key] === filters[key];\n }\n\n return app.metafield[key] === filters[key];\n });\n });\n }\n\n return appMetafields;\n }, [filters, appMetafields]);\n}" - }, - "AppMetafieldFilters": { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "name": "AppMetafieldFilters", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "To filter for app owned metafields, use the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported.\n\nSee [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/preact/app-metafields.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'customer' | 'product' | 'shop' | 'shopUser' | 'variant' | 'company' | 'companyLocation' | 'cart'", - "description": "", - "isOptional": true - } - ], - "value": "interface AppMetafieldFilters {\n id?: AppMetafieldEntryTarget['id'];\n type?: AppMetafieldEntryTarget['type'];\n /**\n * To filter for app owned metafields, use the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported.\n *\n * See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace?: Metafield['namespace'];\n key?: Metafield['key'];\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_MetafieldsApi", - "typeDefinitions": { - "Docs_Checkout_MetafieldsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_MetafieldsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - } - ], - "value": "export interface Docs_Checkout_MetafieldsApi\n extends Pick {}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useApplyMetafieldsChange", - "description": "Returns a function to mutate the `metafields` property of the checkout.", - "type": "UseApplyMetafieldsChangeGeneratedType", - "typeDefinitions": { - "UseApplyMetafieldsChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/metafields.ts", - "name": "UseApplyMetafieldsChangeGeneratedType", - "description": "Returns a function to mutate the `metafields` property of the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/metafields.ts", - "description": "", - "name": "(change: MetafieldChange) => Promise", - "value": "(change: MetafieldChange) => Promise" - }, - "value": "export function useApplyMetafieldsChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: MetafieldChange) => Promise {\n const api = useApi();\n\n if ('applyMetafieldChange' in api) {\n return api.applyMetafieldChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyMetafieldChange',\n api.extension.target,\n );\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - } - ], - "defaultExample": { - "description": "Use the `$app` format to request metafields that are owned by your app in your extension configuration file. Your app exclusively controls structure, data, permissions and optional features for this type of metafield. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.", - "codeblock": { - "title": "Use app owned metafields", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAppMetafields} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [energyRating] = useAppMetafields({\n namespace: '$app',\n key: 'energy-rating',\n type: 'product',\n }).filter(\n (entry) =>\n entry.target.id ===\n shopify.target.value.merchandise.id,\n );\n\n return (\n energyRating && (\n <s-text>\n Energy rating:{' '}\n {energyRating.metafield.value}\n </s-text>\n )\n );\n}\n", - "language": "jsx", - "title": "Preact" - }, - { - "code": "# other configs omitted\n\n[[extensions.metafields]]\n# tip: you can use $app:some-namespace to further segment your data\nnamespace = \"$app\"\nkey = \"energy-rating\"\n", - "language": "toml", - "title": "TOML" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Note", - "description": "The API for interacting with the note applied to checkout.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_NoteApi", - "typeDefinitions": { - "Docs_Standard_NoteApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_NoteApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - } - ], - "value": "export interface Docs_Standard_NoteApi extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "useNote", - "description": "Returns the proposed `note` applied to the checkout.", - "type": "UseNoteGeneratedType", - "typeDefinitions": { - "UseNoteGeneratedType": { - "filePath": "src/surfaces/checkout/preact/note.ts", - "name": "UseNoteGeneratedType", - "description": "Returns the proposed `note` applied to the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/note.ts", - "description": "", - "name": "string | undefined", - "value": "string | undefined" - }, - "value": "export function useNote<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): string | undefined {\n return useSubscription(useApi().note);\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to `purchase.checkout` extension targets.", - "type": "Docs_Checkout_NoteApi", - "typeDefinitions": { - "Docs_Checkout_NoteApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Checkout_NoteApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - } - ], - "value": "export interface Docs_Checkout_NoteApi\n extends Pick {}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - }, - { - "title": "useApplyNoteChange", - "description": "Returns a function to mutate the `note` property of the checkout.", - "type": "UseApplyNoteChangeGeneratedType", - "typeDefinitions": { - "UseApplyNoteChangeGeneratedType": { - "filePath": "src/surfaces/checkout/preact/note.ts", - "name": "UseApplyNoteChangeGeneratedType", - "description": "Returns a function to mutate the `note` property of the checkout.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/note.ts", - "description": "", - "name": "(change: NoteChange) => Promise", - "value": "(change: NoteChange) => Promise" - }, - "value": "export function useApplyNoteChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: NoteChange) => Promise {\n const api = useApi();\n\n if ('applyNoteChange' in api) {\n return api.applyNoteChange;\n }\n\n throw new ExtensionHasNoMethodError('applyNoteChange', api.extension.target);\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Order", - "description": "The API for interacting with the order confirmation, available on the **Thank You** page.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "defaultExample": { - "description": "", - "codeblock": { - "title": "Order confirmation", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {id} =\n shopify.orderConfirmation.value.order;\n\n if (id) {\n return (\n <s-banner>\n Please include your order confirmation ID\n ({id}) in support requests\n </s-banner>\n );\n }\n\n return null;\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "OrderStatusApi", - "description": "> Note: This documentation has moved to customer accounts. Refer to [Order API](/docs/api/customer-account-ui-extensions/apis/order)", - "type": "OrderStatusApiEmpty", - "typeDefinitions": { - "OrderStatusApiEmpty": { - "filePath": "docs/surfaces/checkout/reference/apis/order.doc.ts", - "name": "OrderStatusApiEmpty", - "description": "", - "members": [], - "value": "interface OrderStatusApiEmpty {}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Payments", - "description": "The API for interacting with the payment options.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_PaymentOptionsApi", - "typeDefinitions": { - "Docs_Standard_PaymentOptionsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_PaymentOptionsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - } - ], - "value": "export interface Docs_Standard_PaymentOptionsApi\n extends Pick<\n StandardApi,\n 'availablePaymentOptions' | 'selectedPaymentOptions'\n > {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - } - } - }, - { - "title": "useAvailablePaymentOptions", - "description": "Returns all available payment options.", - "type": "UseAvailablePaymentOptionsGeneratedType", - "typeDefinitions": { - "UseAvailablePaymentOptionsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/payment-options.ts", - "name": "UseAvailablePaymentOptionsGeneratedType", - "description": "Returns all available payment options.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/payment-options.ts", - "description": "", - "name": "PaymentOption[]", - "value": "PaymentOption[]" - }, - "value": "export function useAvailablePaymentOptions<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): PaymentOption[] {\n const api = useApi();\n return useSubscription(api.availablePaymentOptions);\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - } - } - }, - { - "title": "useSelectedPaymentOptions", - "description": "Returns payment options selected by the buyer.", - "type": "UseSelectedPaymentOptionsGeneratedType", - "typeDefinitions": { - "UseSelectedPaymentOptionsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/payment-options.ts", - "name": "UseSelectedPaymentOptionsGeneratedType", - "description": "Returns payment options selected by the buyer.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/payment-options.ts", - "description": "", - "name": "SelectedPaymentOption[]", - "value": "SelectedPaymentOption[]" - }, - "value": "export function useSelectedPaymentOptions<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): SelectedPaymentOption[] {\n const api = useApi();\n return useSubscription(api.selectedPaymentOptions);\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Available payment options", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.availablePaymentOptions.value.some(\n (option) => option.type === 'wallet',\n )\n ) {\n return (\n <s-banner>\n Select an express payment method for\n faster checkout\n </s-banner>\n );\n }\n\n return null;\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "", - "codeblock": { - "title": "Selected payment options", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n if (\n shopify.selectedPaymentOptions.value.some(\n (option) => option.type === 'creditCard',\n )\n ) {\n return (\n <s-banner>\n All credit card transactions are secure\n </s-banner>\n );\n }\n\n return null;\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - } - }, - { - "name": "Storefront API", - "description": "Querying the Storefront API.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_QueryApi", - "typeDefinitions": { - "Docs_Standard_QueryApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_QueryApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - } - ], - "value": "export interface Docs_Standard_QueryApi extends Pick {}" - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - } - } - } - ], - "defaultExample": { - "description": "\nYou can access the [Storefront GraphQL API](/docs/api/storefront) via the `query()` helper function.\nEnsure your extension can use this API by [enabling the `api_access` capability](/docs/api/checkout-ui-extensions/configuration#api-access).\n ", - "codeblock": { - "title": "Access the Storefront API with query", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useEffect, useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {query} = shopify;\n const [data, setData] = useState();\n\n useEffect(() => {\n shopify\n .query(\n `query ($first: Int!) {\n products(first: $first) {\n nodes {\n id\n title\n }\n }\n }`,\n {\n variables: {first: 5},\n },\n )\n .then(({data, errors}) => setData(data))\n .catch(console.error);\n }, [query]);\n\n return (\n <s-unordered-list>\n {data?.products?.nodes.map((node) => (\n <s-list-item key={node.id}>\n {node.title}\n </s-list-item>\n ))}\n </s-unordered-list>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "\nYou can access the [Storefront GraphQL API](/docs/api/storefront) using global `fetch()`.\nEnsure your extension can access the Storefront API via the [`api_access` capability](/docs/api/checkout-ui-extensions/configuration#api-access).\n\nThe `shopify:storefront` protocol will automatically infer your Storefront URL and API version declared in your extension config.\n\nBy omitting the API version (recommended), Shopify will use your API version configured in `shopify.extension.toml`. To change the API version, simply add it to the URL like `shopify:storefront/api/2024-04/graphql.json`.\n\nSee [Storefront GraphQL API endpoints](/docs/api/storefront#endpoints) for more information.\n ", - "codeblock": { - "title": "Accessing the Storefront API with fetch()", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useEffect, useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [data, setData] = useState();\n\n useEffect(() => {\n const getProductsQuery = {\n query: `query ($first: Int!) {\n products(first: $first) {\n nodes {\n id\n title\n }\n }\n }`,\n variables: {first: 5},\n };\n\n fetch('shopify:storefront/api/graphql.json', {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify(getProductsQuery),\n })\n .then((response) => response.json())\n .then(({data, errors}) => setData(data))\n .catch(console.error);\n });\n\n return (\n <s-unordered-list>\n {data?.products?.nodes.map((node) => (\n <s-list-item key={node.id}>\n {node.title}\n </s-list-item>\n ))}\n </s-unordered-list>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Session Token", - "description": "The API for interacting with session tokens.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_SessionTokenApi", - "typeDefinitions": { - "Docs_Standard_SessionTokenApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_SessionTokenApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - } - ], - "value": "export interface Docs_Standard_SessionTokenApi\n extends Pick {}" - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - } - } - }, - { - "title": "useSessionToken", - "description": "Returns a the session token API object.", - "type": "UseSessionTokenGeneratedType", - "typeDefinitions": { - "UseSessionTokenGeneratedType": { - "filePath": "src/surfaces/checkout/preact/session-token.ts", - "name": "UseSessionTokenGeneratedType", - "description": "Provides access to session tokens, which can be used to verify token claims on your app's server.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/session-token.ts", - "description": "", - "name": "SessionToken", - "value": "SessionToken" - }, - "value": "export function useSessionToken<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): SessionToken {\n return useApi().sessionToken;\n}" - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - } - } - } - ], - "defaultExample": { - "description": "\nYou can request a session token from Shopify to use on your application server. The contents of the token claims are signed using your shared app secret so you can trust the claims came from Shopify unaltered.\n\n> Note: You will need to [enable the `network_access` capability](/docs/api/checkout-ui-extensions/configuration#network-access) to use `fetch()`.\n", - "codeblock": { - "title": "Using a session token with fetch()", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useEffect} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {sessionToken} = shopify;\n\n useEffect(() => {\n async function queryApi() {\n // Request a new (or cached) session token from Shopify\n const token =\n await shopify.sessionToken.get();\n console.log('sessionToken.get()', token);\n\n const apiResponse =\n await fetchWithToken(token);\n // Use your response\n console.log('API response', apiResponse);\n }\n\n function fetchWithToken(token) {\n const result = fetch(\n 'https://myapp.com/api/session-token',\n {\n headers: {\n Authorization: `Bearer ${token}`,\n },\n },\n );\n return result;\n }\n\n queryApi();\n }, [sessionToken]);\n\n return (\n <s-banner>\n See console for API response\n </s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "\nThe contents of the token are signed using your shared app secret. The optional `sub` claim contains the customer's `gid` if they are logged in and your app has permission to read customer accounts. For example, a loyalty app that needs to check a customer's point balance can use the `sub` claim to verify the customer's account.\n\n> Caution:\n> Your app server can only trust the claims within the session token. It cannot use the token to trust the entire HTTP request. See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) for details.\n", - "codeblock": { - "title": "Session token claims", - "tabs": [ - { - "code": "{\n // Shopify URL\n \"dest\": \"store-name.myshopify.com\",\n // The Client ID of your app\n \"aud\": \"<clientId>\",\n // When the token expires. Set at 5 minutes.\n \"exp\": 1679954053,\n // When the token was actived\n \"nbf\": 1679953753,\n // When the token was issued\n \"iat\": 1679953753,\n // A unique identifier (a nonce) to prevent replay attacks\n \"jti\": \"6c992878-dbaf-48d1-bb9d-6d9b59814fd1\",\n // Optional claim present when a customer is logged in and your app has permissions to read customer data\n \"sub\": \"gid://shopify/Customer/<customerId>\"\n}\n", - "language": "json", - "title": "session-token.jwt" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Settings", - "description": "The API for interacting with merchant settings.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_SettingsApi", - "typeDefinitions": { - "Docs_Standard_SettingsApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_SettingsApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - } - ], - "value": "export interface Docs_Standard_SettingsApi\n extends Pick {}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - } - } - }, - { - "title": "useSettings", - "description": "Returns the setting values defined by the merchant for the extension.", - "type": "UseSettingsGeneratedType", - "typeDefinitions": { - "UseSettingsGeneratedType": { - "filePath": "src/surfaces/checkout/preact/settings.ts", - "name": "UseSettingsGeneratedType", - "description": "Returns the setting values defined by the merchant for the extension.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/settings.ts", - "description": "", - "name": "Partial", - "value": "Partial" - }, - "value": "export function useSettings<\n Settings extends ExtensionSettings,\n>(): Partial {\n const settings = useSubscription(useApi().settings);\n\n return settings as Settings;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - } - } - } - ], - "defaultExample": { - "description": "\nYou can retrieve settings values within your extension. In React, the `useSettings()` hook re-renders your extension with the latest values.\nIn JavaScript, subscribe to changes and update your UI directly.\n ", - "codeblock": { - "title": "Accessing merchant settings", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-banner>\n {shopify.settings.value.banner_title}\n </s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "examples": { - "description": "", - "examples": [ - { - "description": "\nYou can define settings that merchants can edit within the checkout editor.\nSee [settings](/docs/api/checkout-ui-extensions/configuration#settings-definition) for more information on how to define these.\n ", - "codeblock": { - "title": "Define merchant settings", - "tabs": [ - { - "code": "api_version = \"2026-04\"\n\n[[extensions]]\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\ntype = \"ui_extension\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Checkout.jsx\"\n\n[extensions.settings]\n[[extensions.settings.fields]]\nkey = \"banner_title\"\ntype = \"single_line_text_field\"\nname = \"Banner title\"\ndescription = \"Enter a title for the banner.\"\n[[extensions.settings.fields.validations]]\nname = \"min\"\nvalue = \"5\"\n[[extensions.settings.fields.validations]]\nname = \"max\"\nvalue = \"20\"\n", - "language": "toml", - "title": "shopify.extension.toml" - } - ] - } - } - ] - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Shop", - "description": "The API for interacting with shop.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_ShopApi", - "typeDefinitions": { - "Docs_Standard_ShopApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_ShopApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - } - ], - "value": "export interface Docs_Standard_ShopApi extends Pick {}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - } - } - }, - { - "title": "useShop", - "description": "Returns the `shop` where the checkout is taking place.", - "type": "UseShopGeneratedType", - "typeDefinitions": { - "UseShopGeneratedType": { - "filePath": "src/surfaces/checkout/preact/shop.ts", - "name": "UseShopGeneratedType", - "description": "Returns the `Shop` where the checkout is taking place.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/shop.ts", - "description": "", - "name": "Shop", - "value": "Shop" - }, - "value": "export function useShop<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Shop {\n return useApi().shop;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - } - } - } - ], - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "Storage", - "description": "The API for interacting with local storage.", - "isVisualComponent": false, - "category": "APIs", - "type": "API", - "definitions": [ - { - "title": "StandardApi", - "description": "The base API object provided to `purchase` extension targets.", - "type": "Docs_Standard_StorageApi", - "typeDefinitions": { - "Docs_Standard_StorageApi": { - "filePath": "src/surfaces/checkout/api/docs.ts", - "name": "Docs_Standard_StorageApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - } - ], - "value": "export interface Docs_Standard_StorageApi\n extends Pick {}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - } - } - }, - { - "title": "useStorage", - "description": "Returns the key-value `Storage` interface for the extension target.", - "type": "UseStorageGeneratedType", - "typeDefinitions": { - "UseStorageGeneratedType": { - "filePath": "src/surfaces/checkout/preact/storage.ts", - "name": "UseStorageGeneratedType", - "description": "Returns the key-value `Storage` interface for the extension. Uses `localStorage` and should persist across the buyer's current checkout session. However, data persistence isn't guaranteed and storage is reset when the buyer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions `<=2023-07`, each activated extension target had its own storage.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/storage.ts", - "description": "", - "name": "Storage", - "value": "Storage" - }, - "value": "export function useStorage<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Storage {\n return useApi().storage;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Storage", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useEffect, useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {storage} = shopify;\n const [tosConsent, setTosConsent] =\n useState(false);\n\n useEffect(() => {\n async function readFromStorage() {\n const tosConsent = await storage.read(\n 'tos-consent',\n );\n\n setTosConsent(Boolean(tosConsent));\n }\n\n readFromStorage();\n }, [storage]);\n\n async function cacheConsent(value: boolean) {\n setTosConsent(value);\n await storage.write('tos-consent', value);\n }\n\n return (\n <s-checkbox\n checked={tosConsent}\n onChange={() => cacheConsent(!tosConsent)}\n label=\"I agree with the terms of service\"\n />\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "useApi()", - "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Note: > As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global `shopify` object.", - "isVisualComponent": false, - "type": "React Hook", - "category": "APIs", - "definitions": [ - { - "title": "", - "description": "", - "type": "UseApiGeneratedType", - "typeDefinitions": { - "UseApiGeneratedType": { - "filePath": "src/surfaces/checkout/preact/api.ts", - "name": "UseApiGeneratedType", - "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Note: > As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global `shopify` object.", - "params": [ - { - "name": "_target", - "description": "", - "value": "Target extends keyof RenderExtensionTargets", - "isOptional": true, - "filePath": "src/surfaces/checkout/preact/api.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/api.ts", - "description": "", - "name": "ApiForExtension", - "value": "ApiForExtension" - }, - "value": "export function useApi<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(_target?: Target): ApiForExtension {\n const api = (globalThis as any)?.shopify as ApiForExtension;\n\n if (!api) {\n throw new CheckoutUIExtensionError(\n 'You can only call this hook when running as a checkout UI extension on at least API version 2025-10.',\n );\n }\n return api;\n}" - }, - "RenderExtensionTargets": { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "name": "RenderExtensionTargets", - "description": "A UI extension will register for one or more extension targets using `shopify.extend()`. An extension target in a UI extension is a plain JavaScript function. This function receives some API for interacting with the application, and is expected to return a value in a specific shape. The input arguments and the output type are different for each extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Actions::RenderBefore", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before any actions within each step.", - "deprecationMessage": "Use `purchase.checkout.actions.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CartLineDetails::RenderAfter", - "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element.", - "deprecationMessage": "Use `purchase.checkout.cart-line-item.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CartLineDetails::RenderLineComponents", - "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", - "deprecationMessage": "Use `purchase.cart-line-item.line-components.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CartLines::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items.", - "deprecationMessage": "Use `purchase.checkout.cart-line-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Contact::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the contact form element.", - "deprecationMessage": "Use `purchase.checkout.contact.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CustomerInformation::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after a purchase below the customer information.", - "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` or\n`customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::DeliveryAddress::RenderBefore", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping address header and shipping address form elements.", - "deprecationMessage": "Use `purchase.checkout.delivery-address.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Dynamic::Render", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", - "deprecationMessage": "Use `purchase.checkout.block.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::GiftCard::Render", - "value": "RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", - "deprecationMessage": "Use `purchase.checkout.gift-card.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PaymentMethod::HostedFields::RenderAfter", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders after the hosted fields of a credit card payment method. for a credit card payment method when selected by the buyer.", - "deprecationMessage": "Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PaymentMethod::Render", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", - "deprecationMessage": "Use `purchase.checkout.payment-option-item.details.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PaymentMethod::RenderRequiredAction", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", - "deprecationMessage": "Use `purchase.checkout.payment-option-item.action-required.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupLocations::RenderAfter", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after pickup location options.", - "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupLocations::RenderBefore", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered before pickup location options.", - "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupPoints::RenderAfter", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the pickup points.", - "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupPoints::RenderBefore", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before the pickup points.", - "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Reductions::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements.", - "deprecationMessage": "Use `purchase.checkout.reductions.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Reductions::RenderBefore", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, before the discount form element.", - "deprecationMessage": "Use `purchase.checkout.reductions.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethodDetails::RenderAfter", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-item.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethodDetails::RenderExpanded", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-item.details.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethods::RenderAfter", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method options.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethods::RenderBefore", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping method header and shipping method options.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::CartLineDetails::RenderAfter", - "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.", - "deprecationMessage": "Use `purchase.thank-you.cart-line-item.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::CartLines::RenderAfter", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items on the **Thank you** page.", - "deprecationMessage": "Use `purchase.thank-you.cart-line-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::CustomerInformation::RenderAfter", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.", - "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::Dynamic::Render", - "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", - "deprecationMessage": "Use `purchase.thank-you.block.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.cart-line-item.line-components.render", - "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.actions.render-before", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before any actions within each step." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.block.render", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.cart-line-item.render-after", - "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.cart-line-list.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.chat.render", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >", - "description": "A static extension target that is rendered on top of the checkout page as an overlay. It is positioned in the bottom right corner of the screen." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.contact.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the contact form element." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.delivery-address.render-after", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping address form elements." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.delivery-address.render-before", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping address header and shipping address form elements." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.footer.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the footer." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.gift-card.render", - "value": "RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.header.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the header." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-method-list.render-after", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders below the list of payment methods." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-method-list.render-before", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders between the payment heading and payment method list." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-option-item.action-required.render", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-option-item.details.render", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-option-item.hosted-fields.render-after", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders after the hosted fields of a credit card payment method.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-location-list.render-after", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after pickup location options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-location-list.render-before", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered before pickup location options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-location-option-item.render-after", - "value": "RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the pickup location details within the local pickup option list, for each option." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-point-list.render-after", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the pickup points." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-point-list.render-before", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before the pickup points." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.reductions.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.reductions.render-before", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, before the discount form element." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-item.details.render", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-item.render-after", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-list.render-after", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-list.render-before", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping method header and shipping method options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.announcement.render", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >", - "description": "A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.block.render", - "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.cart-line-item.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.cart-line-list.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.chat.render", - "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >", - "description": "A static extension target that is rendered on top of the **Thank you page** as an overlay. It is positioned in the bottom right corner of the screen." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.customer-information.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.footer.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the footer on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.header.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the header on the **Thank you** page." - } - ], - "value": "export interface RenderExtensionTargets {\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n */\n 'purchase.checkout.actions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n *\n * @deprecated Use `purchase.checkout.actions.render-before` instead.\n * @private\n */\n 'Checkout::Actions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n */\n 'purchase.checkout.cart-line-list.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n *\n * @deprecated Use `purchase.checkout.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::CartLines::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n */\n 'purchase.checkout.cart-line-item.render-after': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n *\n * @deprecated Use `purchase.checkout.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderAfter': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n * @private\n */\n 'purchase.cart-line-item.line-components.render': RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n *\n * @deprecated Use `purchase.cart-line-item.line-components.render` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderLineComponents': RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n */\n 'purchase.checkout.contact.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n *\n * @deprecated Use `purchase.checkout.contact.render-after` instead.\n * @private\n */\n 'Checkout::Contact::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` or\n * `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.\n * @private\n */\n 'Checkout::CustomerInformation::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n *\n * @deprecated Use `purchase.checkout.delivery-address.render-before` instead.\n * @private\n */\n 'Checkout::DeliveryAddress::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n */\n 'purchase.checkout.block.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.checkout.block.render` instead.\n * @private\n */\n 'Checkout::Dynamic::Render': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n */\n 'purchase.thank-you.block.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.thank-you.block.render` instead.\n * @private\n */\n 'Checkout::ThankYou::Dynamic::Render': RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-item.render-after': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLineDetails::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-list.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLines::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n */\n 'purchase.thank-you.customer-information.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CustomerInformation::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n */\n 'purchase.checkout.gift-card.render': RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n * @deprecated Use `purchase.checkout.gift-card.render` instead.\n */\n 'Checkout::GiftCard::Render': RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.details.render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.details.render` instead.\n */\n 'Checkout::PaymentMethod::Render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.hosted-fields.render-after': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n * for a credit card payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.\n */\n 'Checkout::PaymentMethod::HostedFields::RenderAfter': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.action-required.render': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.action-required.render` instead.\n */\n 'Checkout::PaymentMethod::RenderRequiredAction': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders between the payment heading and payment method list.\n *\n */\n 'purchase.checkout.payment-method-list.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders below the list of payment methods.\n *\n */\n 'purchase.checkout.payment-method-list.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n */\n 'purchase.checkout.reductions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n *\n * @deprecated Use `purchase.checkout.reductions.render-before` instead.\n * @private\n */\n 'Checkout::Reductions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n */\n 'purchase.checkout.reductions.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n *\n * @deprecated Use `purchase.checkout.reductions.render-after` instead.\n * @private\n */\n 'Checkout::Reductions::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n */\n 'purchase.checkout.shipping-option-list.render-before': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-before` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderBefore': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n */\n 'purchase.checkout.shipping-option-list.render-after': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderAfter': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-before': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderBefore': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-after': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderAfter': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.render-after': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderAfter': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.details.render': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.details.render` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderExpanded': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-before': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderBefore': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-after': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderAfter': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the pickup location\n * details within the local pickup option list, for each option.\n */\n 'purchase.checkout.pickup-location-option-item.render-after': RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the header.\n */\n 'purchase.checkout.header.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer.\n */\n 'purchase.checkout.footer.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the checkout page as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.checkout.chat.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered below the header on the **Thank you** page.\n */\n 'purchase.thank-you.header.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer on the **Thank you** page.\n */\n 'purchase.thank-you.footer.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.thank-you.chat.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.\n */\n 'purchase.thank-you.announcement.render': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >;\n}" - }, - "RenderExtension": { - "filePath": "src/extension.ts", - "name": "RenderExtension", - "description": "Defines the structure of a render extension, which displays UI in the Shopify admin.", - "members": [ - { - "filePath": "src/extension.ts", - "syntaxKind": "PropertySignature", - "name": "api", - "value": "Api", - "description": "The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying." - }, - { - "filePath": "src/extension.ts", - "syntaxKind": "PropertySignature", - "name": "components", - "value": "ComponentsSet", - "description": "The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target." - }, - { - "filePath": "src/extension.ts", - "syntaxKind": "PropertySignature", - "name": "output", - "value": "void | Promise", - "description": "The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads." - } - ], - "value": "export interface RenderExtension {\n /**\n * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.\n */\n api: Api;\n /**\n * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.\n */\n components: ComponentsSet;\n /**\n * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.\n */\n output: void | Promise;\n}" - }, - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - }, - "AnyCheckoutComponent": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyCheckoutComponent", - "value": "'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField' | 'Chat'", - "description": "The list of supported components. As of October 1st, 2025, this is a subset of the components that will be available in the 2025-10 stable release." - }, - "CartLineItemApi": { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "name": "CartLineItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`." - } - ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" - }, - "RedeemableApi": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "MethodSignature", - "name": "applyRedeemableChange", - "value": "(change: RedeemableAddChange) => Promise", - "description": "Applies a redeemable change to add a redeemable payment method." - } - ], - "value": "export interface RedeemableApi {\n /**\n * Applies a redeemable change to add a redeemable payment method.\n */\n applyRedeemableChange(\n change: RedeemableChange,\n ): Promise;\n}" - }, - "RedeemableAddChange": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "RedeemableAttribute[]", - "description": "The redeemable attributes." - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "identifier", - "value": "string", - "description": "The identifier used to represent the redeemable (e.g. the gift card code)." - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'redeemableAddChange'", - "description": "The type of the `RedeemableChange` API." - } - ], - "value": "export interface RedeemableAddChange {\n /**\n * The type of the `RedeemableChange` API.\n */\n type: 'redeemableAddChange';\n\n /**\n * The redeemable attributes.\n */\n attributes: RedeemableAttribute[];\n\n /**\n * The identifier used to represent the redeemable (e.g. the gift card code).\n */\n identifier: string;\n}" - }, - "RedeemableAttribute": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableAttribute", - "description": "A key-value pair that represents an attribute of a redeemable payment method.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface RedeemableAttribute {\n key: string;\n value: string;\n}" - }, - "RedeemableChangeResult": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "RedeemableChangeResult", - "value": "RedeemableChangeResultSuccess | RedeemableChangeResultError", - "description": "" - }, - "RedeemableChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the redeemable change was applied successfully." - } - ], - "value": "export interface RedeemableChangeResultSuccess {\n /**\n * Indicates that the redeemable change was applied successfully.\n */\n type: 'success';\n}" - }, - "RedeemableChangeResultError": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the redeemable change was not applied successfully." - } - ], - "value": "export interface RedeemableChangeResultError {\n /**\n * Indicates that the redeemable change was not applied successfully.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AnyCheckoutComponentExcept": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyCheckoutComponentExcept", - "value": "'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField' | 'Chat'", - "description": "" - }, - "PaymentOptionItemApi": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "MethodSignature", - "name": "applyPaymentMethodAttributesChange", - "value": "(change: PaymentMethodAttributesUpdateChange) => Promise", - "description": "Sets the attributes of the related payment method." - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "bankIdNumber", - "value": "SubscribableSignalLike", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "paymentMethodAttributes", - "value": "SubscribableSignalLike<\n PaymentMethodAttribute[] | undefined\n >", - "description": "", - "isOptional": true - } - ], - "value": "export interface PaymentOptionItemApi {\n /**\n * Sets the attributes of the related payment method.\n */\n applyPaymentMethodAttributesChange(\n change: PaymentMethodAttributesChange,\n ): Promise;\n paymentMethodAttributes?: SubscribableSignalLike<\n PaymentMethodAttribute[] | undefined\n >;\n bankIdNumber?: SubscribableSignalLike;\n}" - }, - "PaymentMethodAttributesUpdateChange": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttributesUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "PaymentMethodAttribute[]", - "description": "The payment method attributes" - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updatePaymentMethodAttributes'", - "description": "The type of the `PaymentMethodAttributesChange` API." - } - ], - "value": "export interface PaymentMethodAttributesUpdateChange {\n /**\n * The type of the `PaymentMethodAttributesChange` API.\n */\n type: 'updatePaymentMethodAttributes';\n\n /**\n * The payment method attributes\n */\n attributes: PaymentMethodAttribute[];\n}" - }, - "PaymentMethodAttribute": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttribute", - "description": "A key-value pair that represents an attribute of a payment method.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number | boolean", - "description": "" - } - ], - "value": "export interface PaymentMethodAttribute {\n key: string;\n value: string | number | boolean;\n}" - }, - "PaymentMethodAttributesResult": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaymentMethodAttributesResult", - "value": "PaymentMethodAttributesResultSuccess | PaymentMethodAttributesResultError", - "description": "" - }, - "PaymentMethodAttributesResultSuccess": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttributesResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the payment method attributes were set successfully." - } - ], - "value": "export interface PaymentMethodAttributesResultSuccess {\n /**\n * Indicates that the payment method attributes were set successfully.\n */\n type: 'success';\n}" - }, - "PaymentMethodAttributesResultError": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttributesResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the payment method attributes were not set successfully." - } - ], - "value": "export interface PaymentMethodAttributesResultError {\n /**\n * Indicates that the payment method attributes were not set successfully.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "PickupLocationListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "name": "PickupLocationListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupLocationListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "PickupPointListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "name": "PickupPointListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "ShippingOptionItemApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the shipping option the extension is attached to is currently selected in the UI." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "renderMode", - "value": "ShippingOptionItemRenderMode", - "description": "The render mode of the shipping option." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The shipping option the extension is attached to." - } - ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the shipping option the extension is attached to is currently selected in the UI.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of the shipping option.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" - }, - "ShippingOptionItemRenderMode": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemRenderMode", - "description": "The render mode of a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Whether the shipping option is rendered in an overlay." - } - ], - "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay.\n */\n overlay: boolean;\n}" - }, - "ShippingOptionListApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "ShippingOptionListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliverySelectionGroups", - "value": "SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >", - "description": "The list of selection groups available to the buyers. The property will be undefined when no such groups are available." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type." - } - ], - "value": "export interface ShippingOptionListApi {\n /**\n * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.\n */\n target: SubscribableSignalLike;\n /**\n * The list of selection groups available to the buyers. The property will be undefined when no such groups are available.\n */\n deliverySelectionGroups: SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >;\n}" - }, - "DeliverySelectionGroup": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliverySelectionGroup", - "description": "A selection group for delivery options.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "associatedDeliveryOptions", - "value": "DeliveryOptionReference[]", - "description": "The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The sum of each delivery option's cost." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The sum of each delivery option's cost after discounts." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The handle of the selection group." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "If the selection group is selected." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The localized title of the selection group." - } - ], - "value": "export interface DeliverySelectionGroup {\n /**\n * The handle of the selection group.\n */\n handle: string;\n /**\n * If the selection group is selected.\n */\n selected: boolean;\n /**\n * The localized title of the selection group.\n */\n title: string;\n /**\n * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The sum of each delivery option's cost.\n */\n cost: Money;\n /**\n * The sum of each delivery option's cost after discounts.\n */\n costAfterDiscounts: Money;\n}" - }, - "DeliveryGroupList": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliveryGroupList", - "description": "The delivery group list the extension is associated to.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "DeliveryGroup[]", - "description": "The delivery groups that compose this list." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The group type of the delivery group list." - } - ], - "value": "export interface DeliveryGroupList {\n /**\n * The group type of the delivery group list.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups that compose this list.\n */\n deliveryGroups: DeliveryGroup[];\n}" - }, - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - }, - "AllowedComponents": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AllowedComponents", - "value": "Allowed", - "description": "" - }, - "PickupLocationItemApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "name": "PickupLocationItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the pickup location is currently selected." - }, - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The pickup location the extension is attached to." - } - ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the pickup location is currently selected.\n */\n isTargetSelected: SubscribableSignalLike;\n}" - }, - "AnyThankYouComponent": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyThankYouComponent", - "value": "'Abbreviation' | 'Announcement' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'", - "description": "" - }, - "Announcement": { - "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", - "name": "Announcement", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", - "syntaxKind": "PropertySignature", - "name": "announcement", - "value": "{ close(): void; addEventListener(type: \"close\", cb: () => void): void; removeEventListener(type: \"close\", cb: () => void): void; }", - "description": "" - } - ], - "value": "export interface Announcement {\n announcement: {\n close(): void;\n addEventListener(type: 'close', cb: () => void): void;\n removeEventListener(type: 'close', cb: () => void): void;\n };\n}" - }, - "ApiForExtension": { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiForExtension", - "value": "ApiForExtension", - "description": "For a given extension target, returns the type of the API that the extension will receive at runtime." - }, - "RenderExtensionTarget": { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "RenderExtensionTarget", - "value": "keyof RenderExtensionTargets", - "description": "A union type containing all of the extension targets that follow the pattern of accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core) and an additional `api` argument, and using those arguments to render UI." - } - } - } - ], - "defaultExample": { - "description": "\nThe extension API is passed as a parameter to the extension target function.\nIn React, you can access it from any component through the `useApi()` hook.\n ", - "codeblock": { - "title": "Accessing Properties", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n // As of version 2025-10, you no longer need the `useApi` hook.\n // The full API object is accessible via the global `shopify` object.\n return (\n <s-text>\n Shop name: {shopify.shop.name}\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "useExtensionApi()", - "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Caution: This is deprecated, use `useApi` instead.", - "isVisualComponent": false, - "type": "React Hook", - "category": "APIs", - "definitions": [ - { - "title": "", - "description": "", - "type": "UseExtensionApiGeneratedType", - "typeDefinitions": { - "UseExtensionApiGeneratedType": { - "filePath": "src/surfaces/checkout/preact/api.ts", - "name": "UseExtensionApiGeneratedType", - "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Caution: This is deprecated, use `useApi` instead.", - "params": [], - "returns": { - "filePath": "src/surfaces/checkout/preact/api.ts", - "description": "", - "name": "ApiForExtension", - "value": "ApiForExtension" - }, - "value": "export function useExtensionApi<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): ApiForExtension {\n return useApi();\n}" - }, - "ApiForExtension": { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiForExtension", - "value": "ApiForExtension", - "description": "For a given extension target, returns the type of the API that the extension will receive at runtime." - }, - "RenderExtensionTarget": { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "RenderExtensionTarget", - "value": "keyof RenderExtensionTargets", - "description": "A union type containing all of the extension targets that follow the pattern of accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core) and an additional `api` argument, and using those arguments to render UI." - }, - "RenderExtensionTargets": { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "name": "RenderExtensionTargets", - "description": "A UI extension will register for one or more extension targets using `shopify.extend()`. An extension target in a UI extension is a plain JavaScript function. This function receives some API for interacting with the application, and is expected to return a value in a specific shape. The input arguments and the output type are different for each extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Actions::RenderBefore", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before any actions within each step.", - "deprecationMessage": "Use `purchase.checkout.actions.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CartLineDetails::RenderAfter", - "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element.", - "deprecationMessage": "Use `purchase.checkout.cart-line-item.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CartLineDetails::RenderLineComponents", - "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", - "deprecationMessage": "Use `purchase.cart-line-item.line-components.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CartLines::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items.", - "deprecationMessage": "Use `purchase.checkout.cart-line-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Contact::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the contact form element.", - "deprecationMessage": "Use `purchase.checkout.contact.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::CustomerInformation::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after a purchase below the customer information.", - "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` or\n`customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::DeliveryAddress::RenderBefore", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping address header and shipping address form elements.", - "deprecationMessage": "Use `purchase.checkout.delivery-address.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Dynamic::Render", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", - "deprecationMessage": "Use `purchase.checkout.block.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::GiftCard::Render", - "value": "RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", - "deprecationMessage": "Use `purchase.checkout.gift-card.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PaymentMethod::HostedFields::RenderAfter", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders after the hosted fields of a credit card payment method. for a credit card payment method when selected by the buyer.", - "deprecationMessage": "Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PaymentMethod::Render", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", - "deprecationMessage": "Use `purchase.checkout.payment-option-item.details.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PaymentMethod::RenderRequiredAction", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", - "deprecationMessage": "Use `purchase.checkout.payment-option-item.action-required.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupLocations::RenderAfter", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after pickup location options.", - "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupLocations::RenderBefore", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered before pickup location options.", - "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupPoints::RenderAfter", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the pickup points.", - "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::PickupPoints::RenderBefore", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before the pickup points.", - "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Reductions::RenderAfter", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements.", - "deprecationMessage": "Use `purchase.checkout.reductions.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::Reductions::RenderBefore", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, before the discount form element.", - "deprecationMessage": "Use `purchase.checkout.reductions.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethodDetails::RenderAfter", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-item.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethodDetails::RenderExpanded", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-item.details.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethods::RenderAfter", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method options.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ShippingMethods::RenderBefore", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping method header and shipping method options.", - "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-before` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::CartLineDetails::RenderAfter", - "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.", - "deprecationMessage": "Use `purchase.thank-you.cart-line-item.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::CartLines::RenderAfter", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items on the **Thank you** page.", - "deprecationMessage": "Use `purchase.thank-you.cart-line-list.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::CustomerInformation::RenderAfter", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.", - "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "Checkout::ThankYou::Dynamic::Render", - "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", - "deprecationMessage": "Use `purchase.thank-you.block.render` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.cart-line-item.line-components.render", - "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.actions.render-before", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before any actions within each step." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.block.render", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.cart-line-item.render-after", - "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.cart-line-list.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.chat.render", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >", - "description": "A static extension target that is rendered on top of the checkout page as an overlay. It is positioned in the bottom right corner of the screen." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.contact.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the contact form element." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.delivery-address.render-after", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping address form elements." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.delivery-address.render-before", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping address header and shipping address form elements." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.footer.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the footer." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.gift-card.render", - "value": "RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.header.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the header." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-method-list.render-after", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders below the list of payment methods." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-method-list.render-before", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders between the payment heading and payment method list." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-option-item.action-required.render", - "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-option-item.details.render", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", - "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.payment-option-item.hosted-fields.render-after", - "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders after the hosted fields of a credit card payment method.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-location-list.render-after", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after pickup location options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-location-list.render-before", - "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered before pickup location options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-location-option-item.render-after", - "value": "RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the pickup location details within the local pickup option list, for each option." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-point-list.render-after", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately after the pickup points." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.pickup-point-list.render-before", - "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered immediately before the pickup points." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.reductions.render-after", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.reductions.render-before", - "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered in the order summary, before the discount form element." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-item.details.render", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-item.render-after", - "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-list.render-after", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after the shipping method options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.checkout.shipping-option-list.render-before", - "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered between the shipping method header and shipping method options." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.announcement.render", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >", - "description": "A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.block.render", - "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.cart-line-item.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.cart-line-list.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after all line items on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.chat.render", - "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >", - "description": "A static extension target that is rendered on top of the **Thank you page** as an overlay. It is positioned in the bottom right corner of the screen." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.customer-information.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.footer.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the footer on the **Thank you** page." - }, - { - "filePath": "src/surfaces/checkout/extension-targets.ts", - "syntaxKind": "PropertySignature", - "name": "purchase.thank-you.header.render-after", - "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >", - "description": "A static extension target that is rendered below the header on the **Thank you** page." - } - ], - "value": "export interface RenderExtensionTargets {\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n */\n 'purchase.checkout.actions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n *\n * @deprecated Use `purchase.checkout.actions.render-before` instead.\n * @private\n */\n 'Checkout::Actions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n */\n 'purchase.checkout.cart-line-list.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n *\n * @deprecated Use `purchase.checkout.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::CartLines::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n */\n 'purchase.checkout.cart-line-item.render-after': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n *\n * @deprecated Use `purchase.checkout.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderAfter': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n * @private\n */\n 'purchase.cart-line-item.line-components.render': RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n *\n * @deprecated Use `purchase.cart-line-item.line-components.render` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderLineComponents': RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n */\n 'purchase.checkout.contact.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n *\n * @deprecated Use `purchase.checkout.contact.render-after` instead.\n * @private\n */\n 'Checkout::Contact::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` or\n * `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.\n * @private\n */\n 'Checkout::CustomerInformation::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n *\n * @deprecated Use `purchase.checkout.delivery-address.render-before` instead.\n * @private\n */\n 'Checkout::DeliveryAddress::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n */\n 'purchase.checkout.block.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.checkout.block.render` instead.\n * @private\n */\n 'Checkout::Dynamic::Render': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n */\n 'purchase.thank-you.block.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.thank-you.block.render` instead.\n * @private\n */\n 'Checkout::ThankYou::Dynamic::Render': RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-item.render-after': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLineDetails::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-list.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLines::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n */\n 'purchase.thank-you.customer-information.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CustomerInformation::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n */\n 'purchase.checkout.gift-card.render': RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n * @deprecated Use `purchase.checkout.gift-card.render` instead.\n */\n 'Checkout::GiftCard::Render': RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.details.render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.details.render` instead.\n */\n 'Checkout::PaymentMethod::Render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.hosted-fields.render-after': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n * for a credit card payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.\n */\n 'Checkout::PaymentMethod::HostedFields::RenderAfter': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.action-required.render': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.action-required.render` instead.\n */\n 'Checkout::PaymentMethod::RenderRequiredAction': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders between the payment heading and payment method list.\n *\n */\n 'purchase.checkout.payment-method-list.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders below the list of payment methods.\n *\n */\n 'purchase.checkout.payment-method-list.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n */\n 'purchase.checkout.reductions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n *\n * @deprecated Use `purchase.checkout.reductions.render-before` instead.\n * @private\n */\n 'Checkout::Reductions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n */\n 'purchase.checkout.reductions.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n *\n * @deprecated Use `purchase.checkout.reductions.render-after` instead.\n * @private\n */\n 'Checkout::Reductions::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n */\n 'purchase.checkout.shipping-option-list.render-before': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-before` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderBefore': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n */\n 'purchase.checkout.shipping-option-list.render-after': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderAfter': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-before': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderBefore': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-after': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderAfter': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.render-after': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderAfter': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.details.render': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.details.render` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderExpanded': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-before': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderBefore': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-after': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderAfter': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the pickup location\n * details within the local pickup option list, for each option.\n */\n 'purchase.checkout.pickup-location-option-item.render-after': RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the header.\n */\n 'purchase.checkout.header.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer.\n */\n 'purchase.checkout.footer.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the checkout page as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.checkout.chat.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered below the header on the **Thank you** page.\n */\n 'purchase.thank-you.header.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer on the **Thank you** page.\n */\n 'purchase.thank-you.footer.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.thank-you.chat.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.\n */\n 'purchase.thank-you.announcement.render': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >;\n}" - }, - "RenderExtension": { - "filePath": "src/extension.ts", - "name": "RenderExtension", - "description": "Defines the structure of a render extension, which displays UI in the Shopify admin.", - "members": [ - { - "filePath": "src/extension.ts", - "syntaxKind": "PropertySignature", - "name": "api", - "value": "Api", - "description": "The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying." - }, - { - "filePath": "src/extension.ts", - "syntaxKind": "PropertySignature", - "name": "components", - "value": "ComponentsSet", - "description": "The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target." - }, - { - "filePath": "src/extension.ts", - "syntaxKind": "PropertySignature", - "name": "output", - "value": "void | Promise", - "description": "The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads." - } - ], - "value": "export interface RenderExtension {\n /**\n * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.\n */\n api: Api;\n /**\n * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.\n */\n components: ComponentsSet;\n /**\n * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.\n */\n output: void | Promise;\n}" - }, - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - }, - "AnyCheckoutComponent": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyCheckoutComponent", - "value": "'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField' | 'Chat'", - "description": "The list of supported components. As of October 1st, 2025, this is a subset of the components that will be available in the 2025-10 stable release." - }, - "CartLineItemApi": { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "name": "CartLineItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`." - } - ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" - }, - "RedeemableApi": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "MethodSignature", - "name": "applyRedeemableChange", - "value": "(change: RedeemableAddChange) => Promise", - "description": "Applies a redeemable change to add a redeemable payment method." - } - ], - "value": "export interface RedeemableApi {\n /**\n * Applies a redeemable change to add a redeemable payment method.\n */\n applyRedeemableChange(\n change: RedeemableChange,\n ): Promise;\n}" - }, - "RedeemableAddChange": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "RedeemableAttribute[]", - "description": "The redeemable attributes." - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "identifier", - "value": "string", - "description": "The identifier used to represent the redeemable (e.g. the gift card code)." - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'redeemableAddChange'", - "description": "The type of the `RedeemableChange` API." - } - ], - "value": "export interface RedeemableAddChange {\n /**\n * The type of the `RedeemableChange` API.\n */\n type: 'redeemableAddChange';\n\n /**\n * The redeemable attributes.\n */\n attributes: RedeemableAttribute[];\n\n /**\n * The identifier used to represent the redeemable (e.g. the gift card code).\n */\n identifier: string;\n}" - }, - "RedeemableAttribute": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableAttribute", - "description": "A key-value pair that represents an attribute of a redeemable payment method.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface RedeemableAttribute {\n key: string;\n value: string;\n}" - }, - "RedeemableChangeResult": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "RedeemableChangeResult", - "value": "RedeemableChangeResultSuccess | RedeemableChangeResultError", - "description": "" - }, - "RedeemableChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the redeemable change was applied successfully." - } - ], - "value": "export interface RedeemableChangeResultSuccess {\n /**\n * Indicates that the redeemable change was applied successfully.\n */\n type: 'success';\n}" - }, - "RedeemableChangeResultError": { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "name": "RedeemableChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the redeemable change was not applied successfully." - } - ], - "value": "export interface RedeemableChangeResultError {\n /**\n * Indicates that the redeemable change was not applied successfully.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AnyCheckoutComponentExcept": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyCheckoutComponentExcept", - "value": "'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField' | 'Chat'", - "description": "" - }, - "PaymentOptionItemApi": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "MethodSignature", - "name": "applyPaymentMethodAttributesChange", - "value": "(change: PaymentMethodAttributesUpdateChange) => Promise", - "description": "Sets the attributes of the related payment method." - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "bankIdNumber", - "value": "SubscribableSignalLike", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "paymentMethodAttributes", - "value": "SubscribableSignalLike<\n PaymentMethodAttribute[] | undefined\n >", - "description": "", - "isOptional": true - } - ], - "value": "export interface PaymentOptionItemApi {\n /**\n * Sets the attributes of the related payment method.\n */\n applyPaymentMethodAttributesChange(\n change: PaymentMethodAttributesChange,\n ): Promise;\n paymentMethodAttributes?: SubscribableSignalLike<\n PaymentMethodAttribute[] | undefined\n >;\n bankIdNumber?: SubscribableSignalLike;\n}" - }, - "PaymentMethodAttributesUpdateChange": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttributesUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "PaymentMethodAttribute[]", - "description": "The payment method attributes" - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updatePaymentMethodAttributes'", - "description": "The type of the `PaymentMethodAttributesChange` API." - } - ], - "value": "export interface PaymentMethodAttributesUpdateChange {\n /**\n * The type of the `PaymentMethodAttributesChange` API.\n */\n type: 'updatePaymentMethodAttributes';\n\n /**\n * The payment method attributes\n */\n attributes: PaymentMethodAttribute[];\n}" - }, - "PaymentMethodAttribute": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttribute", - "description": "A key-value pair that represents an attribute of a payment method.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number | boolean", - "description": "" - } - ], - "value": "export interface PaymentMethodAttribute {\n key: string;\n value: string | number | boolean;\n}" - }, - "PaymentMethodAttributesResult": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaymentMethodAttributesResult", - "value": "PaymentMethodAttributesResultSuccess | PaymentMethodAttributesResultError", - "description": "" - }, - "PaymentMethodAttributesResultSuccess": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttributesResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the payment method attributes were set successfully." - } - ], - "value": "export interface PaymentMethodAttributesResultSuccess {\n /**\n * Indicates that the payment method attributes were set successfully.\n */\n type: 'success';\n}" - }, - "PaymentMethodAttributesResultError": { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "name": "PaymentMethodAttributesResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the payment method attributes were not set successfully." - } - ], - "value": "export interface PaymentMethodAttributesResultError {\n /**\n * Indicates that the payment method attributes were not set successfully.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "PickupLocationListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "name": "PickupLocationListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupLocationListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "PickupPointListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "name": "PickupPointListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "ShippingOptionItemApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the shipping option the extension is attached to is currently selected in the UI." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "renderMode", - "value": "ShippingOptionItemRenderMode", - "description": "The render mode of the shipping option." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The shipping option the extension is attached to." - } - ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the shipping option the extension is attached to is currently selected in the UI.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of the shipping option.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" - }, - "ShippingOptionItemRenderMode": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemRenderMode", - "description": "The render mode of a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Whether the shipping option is rendered in an overlay." - } - ], - "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay.\n */\n overlay: boolean;\n}" - }, - "ShippingOptionListApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "ShippingOptionListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliverySelectionGroups", - "value": "SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >", - "description": "The list of selection groups available to the buyers. The property will be undefined when no such groups are available." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type." - } - ], - "value": "export interface ShippingOptionListApi {\n /**\n * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.\n */\n target: SubscribableSignalLike;\n /**\n * The list of selection groups available to the buyers. The property will be undefined when no such groups are available.\n */\n deliverySelectionGroups: SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >;\n}" - }, - "DeliverySelectionGroup": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliverySelectionGroup", - "description": "A selection group for delivery options.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "associatedDeliveryOptions", - "value": "DeliveryOptionReference[]", - "description": "The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The sum of each delivery option's cost." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The sum of each delivery option's cost after discounts." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The handle of the selection group." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "If the selection group is selected." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The localized title of the selection group." - } - ], - "value": "export interface DeliverySelectionGroup {\n /**\n * The handle of the selection group.\n */\n handle: string;\n /**\n * If the selection group is selected.\n */\n selected: boolean;\n /**\n * The localized title of the selection group.\n */\n title: string;\n /**\n * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The sum of each delivery option's cost.\n */\n cost: Money;\n /**\n * The sum of each delivery option's cost after discounts.\n */\n costAfterDiscounts: Money;\n}" - }, - "DeliveryGroupList": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliveryGroupList", - "description": "The delivery group list the extension is associated to.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "DeliveryGroup[]", - "description": "The delivery groups that compose this list." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The group type of the delivery group list." - } - ], - "value": "export interface DeliveryGroupList {\n /**\n * The group type of the delivery group list.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups that compose this list.\n */\n deliveryGroups: DeliveryGroup[];\n}" - }, - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - }, - "AllowedComponents": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AllowedComponents", - "value": "Allowed", - "description": "" - }, - "PickupLocationItemApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "name": "PickupLocationItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the pickup location is currently selected." - }, - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The pickup location the extension is attached to." - } - ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the pickup location is currently selected.\n */\n isTargetSelected: SubscribableSignalLike;\n}" - }, - "AnyThankYouComponent": { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyThankYouComponent", - "value": "'Abbreviation' | 'Announcement' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'", - "description": "" - }, - "Announcement": { - "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", - "name": "Announcement", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", - "syntaxKind": "PropertySignature", - "name": "announcement", - "value": "{ close(): void; addEventListener(type: \"close\", cb: () => void): void; removeEventListener(type: \"close\", cb: () => void): void; }", - "description": "" - } - ], - "value": "export interface Announcement {\n announcement: {\n close(): void;\n addEventListener(type: 'close', cb: () => void): void;\n removeEventListener(type: 'close', cb: () => void): void;\n };\n}" - } - } - } - ], - "defaultExample": { - "description": "\nThe extension API is passed as a parameter to the extension target function.\nIn React, you can access it from any component through the `useExtensionApi()` hook.\n ", - "codeblock": { - "title": "Accessing Properties", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-text>\n Shop name: {shopify.shop.name}\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "useSubscription()", - "description": "Subscribes to the special wrapper type that all \"changeable\" values in the checkout use. This hook extracts the most recent value from that object, and subscribes to update the value when changes occur in the checkout.\n\n> Note: > As of version 2025-10, you no longer need this hook. When you access `.value` > (instead of `.current`) on subscribable properties, Preact will automatically > re-render as `.value` changes.", - "isVisualComponent": false, - "type": "React Hook", - "category": "APIs", - "definitions": [ - { - "title": "", - "description": "", - "type": "UseSubscriptionGeneratedType", - "typeDefinitions": { - "UseSubscriptionGeneratedType": { - "filePath": "src/surfaces/checkout/preact/subscription.ts", - "name": "UseSubscriptionGeneratedType", - "description": "Subscribes to the special wrapper type that all \"changeable\" values in the checkout use. This hook extracts the most recent value from that object, and subscribes to update the value when changes occur in the checkout.\n\n> Note: > As of version 2025-10, you no longer need this hook. When you access `.value` > (instead of `.current`) on subscribable properties, Preact will automatically > re-render as `.value` changes.", - "params": [ - { - "name": "subscription", - "description": "", - "value": "SubscribableSignalLike", - "filePath": "src/surfaces/checkout/preact/subscription.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/preact/subscription.ts", - "description": "", - "name": "Value", - "value": "Value" - }, - "value": "export function useSubscription(\n subscription: SubscribableSignalLike,\n): Value {\n const [, setValue] = useState(subscription.value);\n\n useEffect(() => {\n let didUnsubscribe = false;\n\n const checkForUpdates: Subscriber = (newValue) => {\n if (didUnsubscribe) {\n return;\n }\n\n setValue(newValue);\n };\n\n const unsubscribe = subscription.subscribe(checkForUpdates);\n\n // Because we're subscribing in a passive effect,\n // it's possible for an update to occur between render and the effect handler.\n // Check for this and schedule an update if work has occurred.\n checkForUpdates(subscription.value);\n\n return () => {\n didUnsubscribe = true;\n unsubscribe();\n };\n }, [subscription]);\n\n return subscription.value;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - } - ], - "defaultExample": { - "description": "", - "codeblock": { - "title": "Subscribing to changes", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n // As of version 2025-10, you no longer need the `useSubscription` hook.\n // When you access `.value` on subscribable properties,\n // Preact will automatically re-render as `.value` changes.\n return (\n <s-banner>\n {shopify.cost.totalAmount.value.amount}\n </s-banner>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "Targets", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ] - }, - { - "name": "purchase.address-autocomplete.format-suggestion", - "description": "\n An extension target that formats the selected address suggestion provided by a [`purchase.address-autocomplete.suggest`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest) target. This formatted address is used to auto-populate the fields of the address form.\n\n It must return a [`formattedAddress`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-format-suggestion#addressautocompleteformatsuggestionoutput-propertydetail-formattedaddress).\n\n > Caution:\n > This extension target is only necessary if the corresponding [`purchase.address-autocomplete.suggest`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest) target does not provide a `formattedAddress` for the suggestions. If a formatted address is provided with each suggestion, then this target will not be called.\n >\n > If the [`purchase.address-autocomplete.suggest`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest) target is not implemented, then this target will not work.\n\n > Note:\n > - This target does not support rendering UI components.\n > - This extension can only be developed as a JavaScript extension using the `ui-extensions` library.\n > - The [app extension configuration](/docs/apps/app-extensions/configuration) `shopify.extension.toml` file is shared between this extension target and [`purchase.address-autocomplete.suggest`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest). This includes extension settings specified in the configuration file.\n ", - "subCategory": "Address", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.address-autocomplete.format-suggestion", - "tabs": [ - { - "code": "export default async function extension() {\n // 1. Use the suggestion the buyer selected\n const {selectedSuggestion} = shopify.target;\n\n // 2. Fetch the address parts to format the address\n const response = await fetch(\n `https://your-app.com/api/fetch-address?id=${selectedSuggestion.id}`,\n );\n const {\n address1,\n address2,\n city,\n zip,\n provinceCode,\n countryCode,\n } = await response.json();\n\n // 3. Return a formatted address\n return {\n formattedAddress: {\n address1,\n address2,\n city,\n zip,\n provinceCode,\n countryCode,\n },\n };\n}\n", - "language": "js", - "title": "JavaScript" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - } - ], - "definitions": [ - { - "title": "AddressAutocompleteFormatSuggestionApi", - "description": "The API object provided to the `purchase.address-autocomplete.format-suggestion` extension target.", - "type": "AddressAutocompleteFormatSuggestionApi", - "typeDefinitions": { - "AddressAutocompleteFormatSuggestionApi": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", - "name": "AddressAutocompleteFormatSuggestionApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The autocomplete suggestion that the buyer selected during checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface AddressAutocompleteFormatSuggestionApi {\n /**\n * The autocomplete suggestion that the buyer selected during checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n target: Target;\n}" - }, - "Target": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", - "name": "Target", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", - "syntaxKind": "PropertySignature", - "name": "selectedSuggestion", - "value": "AddressAutocompleteSuggestion", - "description": "" - } - ], - "value": "interface Target {\n selectedSuggestion: AddressAutocompleteSuggestion;\n}" - }, - "AddressAutocompleteSuggestion": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "AddressAutocompleteSuggestion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "formattedAddress", - "value": "AutocompleteAddress", - "description": "The address object used to auto-populate the remaining address fields.\n\nIf this value is returned for every suggestion, then the `purchase.address-autocomplete.format-suggestion` extension target is not needed.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A textual identifier that uniquely identifies an autocomplete suggestion or address. This identifier may be used to search for a formatted address.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "\"35ef8d55-dceb-4ed8-847b-2f2fc7472f14\"", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The address suggestion text presented to the buyer in the list of autocomplete suggestions.\n\nThis text is shown to the buyer as-is. No attempts will be made to parse it.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "\"123 Main St, Toronto, ON, CA\"", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "matchedSubstrings", - "value": "MatchedSubstring[]", - "description": "A list of substrings that matched the original search query.\n\nIf `matchedSubstrings` are provided, then they will be used to highlight the substrings of the suggestions that matched the original search query.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{offset: 0, length: 4}]", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AddressAutocompleteSuggestion {\n /**\n * The address suggestion text presented to the buyer in the list of autocomplete suggestions.\n *\n * This text is shown to the buyer as-is. No attempts will be made to parse it.\n *\n * @example \"123 Main St, Toronto, ON, CA\"\n */\n label: string;\n\n /**\n * A textual identifier that uniquely identifies an autocomplete suggestion\n * or address. This identifier may be used to search for a formatted address.\n *\n * @example \"35ef8d55-dceb-4ed8-847b-2f2fc7472f14\"\n */\n id?: string;\n\n /**\n * A list of substrings that matched the original search query.\n *\n * If `matchedSubstrings` are provided, then they will be used to highlight the substrings\n * of the suggestions that matched the original search query.\n *\n * @example [{offset: 0, length: 4}]\n */\n matchedSubstrings?: MatchedSubstring[];\n\n /**\n * The address object used to auto-populate the remaining address fields.\n *\n * If this value is returned for every suggestion, then the\n * `purchase.address-autocomplete.format-suggestion` extension target is not needed.\n */\n formattedAddress?: AutocompleteAddress;\n}" - }, - "AutocompleteAddress": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "AutocompleteAddress", - "description": "An address object used to auto-populate the address form fields.\n\nAll fields are optional", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "latitude", - "value": "number", - "description": "The latitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "43.6556377", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "longitude", - "value": "number", - "description": "The longitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "-79.38681079999999", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AutocompleteAddress\n extends Pick<\n MailingAddress,\n | 'address1'\n | 'address2'\n | 'city'\n | 'company'\n | 'countryCode'\n | 'provinceCode'\n | 'zip'\n > {\n /**\n * The latitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 43.6556377\n */\n latitude?: number;\n\n /**\n * The longitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example -79.38681079999999\n */\n longitude?: number;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "MatchedSubstring": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "MatchedSubstring", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "length", - "value": "number", - "description": "The length of the matched substring in the suggestion label text." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "offset", - "value": "number", - "description": "The start location of the matched substring in the suggestion label text." - } - ], - "value": "export interface MatchedSubstring {\n /**\n * The start location of the matched substring in the suggestion label text.\n */\n offset: number;\n /**\n * The length of the matched substring in the suggestion label text.\n */\n length: number;\n}" - } - } - }, - { - "title": "AddressAutocompleteFormatSuggestionOutput", - "description": "The object expected to be returned by the `purchase.address-autocomplete.format-suggestion` extension target.", - "type": "AddressAutocompleteFormatSuggestionOutput", - "typeDefinitions": { - "AddressAutocompleteFormatSuggestionOutput": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", - "name": "AddressAutocompleteFormatSuggestionOutput", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", - "syntaxKind": "PropertySignature", - "name": "formattedAddress", - "value": "AutocompleteAddress", - "description": "The formatted address that will be used to populate the native address fields." - } - ], - "value": "export interface AddressAutocompleteFormatSuggestionOutput {\n /**\n * The formatted address that will be used to populate the native address fields.\n */\n formattedAddress: AutocompleteAddress;\n}" - }, - "AutocompleteAddress": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "AutocompleteAddress", - "description": "An address object used to auto-populate the address form fields.\n\nAll fields are optional", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "latitude", - "value": "number", - "description": "The latitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "43.6556377", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "longitude", - "value": "number", - "description": "The longitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "-79.38681079999999", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AutocompleteAddress\n extends Pick<\n MailingAddress,\n | 'address1'\n | 'address2'\n | 'city'\n | 'company'\n | 'countryCode'\n | 'provinceCode'\n | 'zip'\n > {\n /**\n * The latitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 43.6556377\n */\n latitude?: number;\n\n /**\n * The longitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example -79.38681079999999\n */\n longitude?: number;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - } - } - }, - { - "title": "AddressAutocompleteStandardApi", - "description": "The base API object provided to this and other `purchase.address-autocomplete` extension targets.", - "type": "AddressAutocompleteStandardApi", - "typeDefinitions": { - "AddressAutocompleteStandardApi": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "name": "AddressAutocompleteStandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "AppMetafieldEntry[]", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Tip: > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*" - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[] | undefined", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "MailingAddress | undefined", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "CheckoutToken | undefined", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "ExtensionSettings", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor)." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "MailingAddress | undefined", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke.\n\n> Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The runner version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'unstable'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "name": "Extension", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2023-10', '2024-01', '2024-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "Capability[]", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "The information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "boolean", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back.\n\nIf the extension is not capable of rendering UI components, then the value will always be false." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "interface Extension<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2023-10', '2024-01', '2024-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: Capability[];\n\n /**\n * The information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n *\n * If the extension is not capable of rendering UI components, then the value will always be false.\n */\n rendered: boolean;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "Country | undefined", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "Currency", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "Language", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "Language", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "Market | undefined", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. If the market is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "Timezone", - "description": "The buyer’s time zone." - } - ], - "value": "interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: Currency;\n\n /**\n * The buyer’s time zone.\n */\n timezone: Timezone;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: Language;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: Language;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. If the country is unknown, then the value is undefined.\n */\n country: Country | undefined;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. If the market is unknown,\n * then the value is undefined.\n */\n market: Market | undefined;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.address-autocomplete.suggest", - "description": "\n An extension target that provides address autocomplete suggestions for address forms at checkout. Suggestions are presented to customers for delivery, billing, and pickup point addresses.\n\n The extension target must return a list of address [`suggestions`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest#addressautocompletesuggestoutput-propertydetail-suggestions).\n\n If a formatted address is provided with each suggestion, then it will be used to auto-populate the fields in the address form when the customer selects a suggested address.\n\n Optionally, you can implement the [`purchase.address-autocomplete.format-suggestion`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-format-suggestion) extension target to format an address based on the address suggestion selected by the customer.\n\n > Note:\n > - This target does not support rendering UI components.\n > - This extension can only be developed as a JavaScript extension using the `ui-extensions` library.\n > - The [app extension configuration](/docs/apps/app-extensions/configuration) `shopify.extension.toml` file is shared between this extension target and [`purchase.address-autocomplete.format-suggestion`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-format-suggestion). This includes extension settings specified in the configuration file.\n ", - "subCategory": "Address", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.address-autocomplete.suggest", - "tabs": [ - { - "code": "export default async function extension() {\n // 1. Use the query term the buyer entered\n const {field, value} = shopify.target;\n\n // 2. Fetch address suggestions\n const response = await fetch(\n `https://your-app.com/api/address-suggestions?query=${value}&field=${field}`,\n {signal: shopify.signal},\n );\n\n // 3. Map response data to expected format\n const {data} = await response.json();\n const suggestions = data.map((suggestion) => {\n return {\n id: suggestion.id,\n label: suggestion.label,\n matchedSubstrings:\n suggestion.matchedSubstrings,\n formattedAddress: {\n address1: suggestion.address1,\n address2: suggestion.address2,\n city: suggestion.city,\n zip: suggestion.zip,\n provinceCode: suggestion.provinceCode,\n countryCode: suggestion.countryCode,\n },\n };\n });\n\n // 4. Return up to five address suggestions\n return {\n suggestions: suggestions.slice(0, 5),\n };\n}\n", - "language": "js", - "title": "JavaScript" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - } - ], - "definitions": [ - { - "title": "AddressAutocompleteSuggestApi", - "description": "The API object provided to the `purchase.address-autocomplete.suggest` extension target.", - "type": "AddressAutocompleteSuggestApi", - "typeDefinitions": { - "AddressAutocompleteSuggestApi": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "name": "AddressAutocompleteSuggestApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "syntaxKind": "PropertySignature", - "name": "signal", - "value": "AbortSignal", - "description": "The signal that the extension should listen to for cancellation requests.\n\nIf the signal is aborted, the extension should cancel any ongoing requests. The signal will be aborted either when the buyer navigates away from the address field or when the debounced query value changes.\n\nPass this signal to any asynchronous operations that need to be cancelled, like `fetch`." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The current state of the address form that the buyer is interacting with.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface AddressAutocompleteSuggestApi {\n /**\n * The signal that the extension should listen to for cancellation requests.\n *\n * If the signal is aborted, the extension should cancel any ongoing requests.\n * The signal will be aborted either when the buyer navigates away from the\n * address field or when the debounced query value changes.\n *\n * Pass this signal to any asynchronous operations that need to be cancelled,\n * like `fetch`.\n */\n signal: AbortSignal;\n\n /**\n * The current state of the address form that the buyer is interacting with.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n target: Target;\n}" - }, - "Target": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "name": "Target", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "'address1' | 'zip'", - "description": "The `MailingAddress` field that the buyer is interacting with.\n\nThis field can either be `address1` or `zip` depending on the country selected by the buyer during checkout.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "\"address1\"", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "syntaxKind": "PropertySignature", - "name": "selectedCountryCode", - "value": "CountryCode", - "description": "The `countryCode` selected in the address form that the buyer is interacting with.\n\nThis code is in ISO 3166 Alpha-2 format representing the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value of the `field` the buyer is interacting with.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "\"123 M\"", - "title": "Example" - } - ] - } - ] - } - ], - "value": "interface Target {\n /**\n * The current value of the `field` the buyer is interacting with.\n *\n * @example \"123 M\"\n */\n value: string;\n\n /**\n * The `MailingAddress` field that the buyer is interacting with.\n *\n * This field can either be `address1` or `zip` depending on the country\n * selected by the buyer during checkout.\n *\n * @example \"address1\"\n */\n field: 'address1' | 'zip';\n\n /**\n * The `countryCode` selected in the address form that the buyer is interacting with.\n *\n * This code is in ISO 3166 Alpha-2 format representing the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * @example 'CA' for Canada.\n */\n selectedCountryCode?: CountryCode;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - } - } - }, - { - "title": "AddressAutocompleteSuggestOutput", - "description": "The object expected to be returned by the `purchase.address-autocomplete.suggest` extension target.", - "type": "AddressAutocompleteSuggestOutput", - "typeDefinitions": { - "AddressAutocompleteSuggestOutput": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "name": "AddressAutocompleteSuggestOutput", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", - "syntaxKind": "PropertySignature", - "name": "suggestions", - "value": "AddressAutocompleteSuggestion[]", - "description": "An array of address autocomplete suggestions to show to the buyer.\n\n> Note: Only the first five suggestions will be displayed to the buyer." - } - ], - "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n *\n * > Note: Only the first five suggestions will be displayed to the buyer.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" - }, - "AddressAutocompleteSuggestion": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "AddressAutocompleteSuggestion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "formattedAddress", - "value": "AutocompleteAddress", - "description": "The address object used to auto-populate the remaining address fields.\n\nIf this value is returned for every suggestion, then the `purchase.address-autocomplete.format-suggestion` extension target is not needed.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A textual identifier that uniquely identifies an autocomplete suggestion or address. This identifier may be used to search for a formatted address.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "\"35ef8d55-dceb-4ed8-847b-2f2fc7472f14\"", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The address suggestion text presented to the buyer in the list of autocomplete suggestions.\n\nThis text is shown to the buyer as-is. No attempts will be made to parse it.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "\"123 Main St, Toronto, ON, CA\"", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "matchedSubstrings", - "value": "MatchedSubstring[]", - "description": "A list of substrings that matched the original search query.\n\nIf `matchedSubstrings` are provided, then they will be used to highlight the substrings of the suggestions that matched the original search query.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{offset: 0, length: 4}]", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AddressAutocompleteSuggestion {\n /**\n * The address suggestion text presented to the buyer in the list of autocomplete suggestions.\n *\n * This text is shown to the buyer as-is. No attempts will be made to parse it.\n *\n * @example \"123 Main St, Toronto, ON, CA\"\n */\n label: string;\n\n /**\n * A textual identifier that uniquely identifies an autocomplete suggestion\n * or address. This identifier may be used to search for a formatted address.\n *\n * @example \"35ef8d55-dceb-4ed8-847b-2f2fc7472f14\"\n */\n id?: string;\n\n /**\n * A list of substrings that matched the original search query.\n *\n * If `matchedSubstrings` are provided, then they will be used to highlight the substrings\n * of the suggestions that matched the original search query.\n *\n * @example [{offset: 0, length: 4}]\n */\n matchedSubstrings?: MatchedSubstring[];\n\n /**\n * The address object used to auto-populate the remaining address fields.\n *\n * If this value is returned for every suggestion, then the\n * `purchase.address-autocomplete.format-suggestion` extension target is not needed.\n */\n formattedAddress?: AutocompleteAddress;\n}" - }, - "AutocompleteAddress": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "AutocompleteAddress", - "description": "An address object used to auto-populate the address form fields.\n\nAll fields are optional", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "latitude", - "value": "number", - "description": "The latitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "43.6556377", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "longitude", - "value": "number", - "description": "The longitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "-79.38681079999999", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AutocompleteAddress\n extends Pick<\n MailingAddress,\n | 'address1'\n | 'address2'\n | 'city'\n | 'company'\n | 'countryCode'\n | 'provinceCode'\n | 'zip'\n > {\n /**\n * The latitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 43.6556377\n */\n latitude?: number;\n\n /**\n * The longitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example -79.38681079999999\n */\n longitude?: number;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "MatchedSubstring": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "name": "MatchedSubstring", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "length", - "value": "number", - "description": "The length of the matched substring in the suggestion label text." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", - "syntaxKind": "PropertySignature", - "name": "offset", - "value": "number", - "description": "The start location of the matched substring in the suggestion label text." - } - ], - "value": "export interface MatchedSubstring {\n /**\n * The start location of the matched substring in the suggestion label text.\n */\n offset: number;\n /**\n * The length of the matched substring in the suggestion label text.\n */\n length: number;\n}" - } - } - }, - { - "title": "AddressAutocompleteStandardApi", - "description": "The base API object provided to this and other `purchase.address-autocomplete` extension targets.", - "type": "AddressAutocompleteStandardApi", - "typeDefinitions": { - "AddressAutocompleteStandardApi": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "name": "AddressAutocompleteStandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "AppMetafieldEntry[]", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Tip: > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*" - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[] | undefined", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "MailingAddress | undefined", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "CheckoutToken | undefined", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "ExtensionSettings", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor)." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "MailingAddress | undefined", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke.\n\n> Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The runner version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'unstable'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "name": "Extension", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2023-10', '2024-01', '2024-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "Capability[]", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "The information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "boolean", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back.\n\nIf the extension is not capable of rendering UI components, then the value will always be false." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "interface Extension<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2023-10', '2024-01', '2024-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: Capability[];\n\n /**\n * The information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n *\n * If the extension is not capable of rendering UI components, then the value will always be false.\n */\n rendered: boolean;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "Country | undefined", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "Currency", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "Language", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "Language", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "Market | undefined", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. If the market is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "Timezone", - "description": "The buyer’s time zone." - } - ], - "value": "interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: Currency;\n\n /**\n * The buyer’s time zone.\n */\n timezone: Timezone;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: Language;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: Language;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. If the country is unknown, then the value is undefined.\n */\n country: Country | undefined;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. If the market is unknown,\n * then the value is undefined.\n */\n market: Market | undefined;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.actions.render-before", - "description": "A static extension target that is rendered immediately before any actions within each step.", - "subCategory": "Navigation", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.block.render", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\n The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", - "subCategory": "Block", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.cart-line-item.render-after", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element.\n\n > Caution:\n > This extension target will not be rendered if the line item is a custom line item belonging to a draft order invoice.\n ", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-text>\n Line item title:{' '}\n {shopify.target.value.merchandise.title}\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Order Summary", - "definitions": [ - { - "title": "CartLineItemApi", - "description": "The API object provided to this and other `cart-line-item` extension targets.", - "type": "CartLineItemApi", - "typeDefinitions": { - "CartLineItemApi": { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "name": "CartLineItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`." - } - ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.cart-line-list.render-after", - "description": "A static extension target that is rendered after all line items.", - "subCategory": "Order Summary", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.contact.render-after", - "description": "A static extension target that is rendered immediately after the contact form element.", - "subCategory": "Information", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.delivery-address.render-after", - "description": "A static extension target that is rendered after the shipping address form elements.", - "subCategory": "Shipping", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.delivery-address.render-before", - "description": "A static extension target that is rendered between the shipping address header and shipping address form elements.", - "subCategory": "Shipping", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.footer.render-after", - "description": "A static extension target that is rendered below the footer.\n\n > Tip:\n > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading.\n > See: [Spinner](/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](/docs/api/checkout-ui-extensions/components/structure/blockspacer).\n ", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "subCategory": "Footer", - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.header.render-after", - "description": "A static extension target that is rendered below the header.\n\n > Tip:\n > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading.\n > See: [Spinner](/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](/docs/api/checkout-ui-extensions/components/structure/blockspacer).\n ", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "subCategory": "Header", - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.payment-method-list.render-after", - "description": "A static extension target that renders below the list of payment methods.", - "subCategory": "Payments", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.payment-method-list.render-before", - "description": "A static extension target that renders between the payment heading and payment method list.", - "subCategory": "Payments", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.pickup-location-list.render-after", - "description": "A static extension target that is rendered after pickup location options.", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Local Pickup", - "definitions": [ - { - "title": "PickupLocationListApi", - "description": "The API object provided to this and other `pickup-location-list` extension targets.", - "type": "PickupLocationListApi", - "typeDefinitions": { - "PickupLocationListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "name": "PickupLocationListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupLocationListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.pickup-location-list.render-before", - "description": "A static extension target that is rendered before pickup location options.", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Local Pickup", - "definitions": [ - { - "title": "PickupLocationListApi", - "description": "The API object provided to this and other `pickup-location-list` extension targets.", - "type": "PickupLocationListApi", - "typeDefinitions": { - "PickupLocationListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "name": "PickupLocationListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupLocationListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.pickup-location-option-item.render-after", - "description": "A static extension target that is rendered after the pickup location details within the local pickup option list, for each option.", - "defaultExample": { - "description": "", - "codeblock": { - "title": "Reading the selected pickup location option", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {usePickupLocationOptionTarget} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {\n isTargetSelected,\n pickupLocationOptionTarget,\n } = usePickupLocationOptionTarget();\n\n const title = pickupLocationOptionTarget?.title;\n\n if (isTargetSelected) {\n return <s-text>{title}</s-text>;\n }\n\n return null;\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Local Pickup", - "definitions": [ - { - "title": "PickupLocationItemApi", - "description": "The API object provided to this and other `pickup-location-option-item` extension targets.", - "type": "PickupLocationItemApi", - "typeDefinitions": { - "PickupLocationItemApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "name": "PickupLocationItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the pickup location is currently selected." - }, - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The pickup location the extension is attached to." - } - ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the pickup location is currently selected.\n */\n isTargetSelected: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.pickup-point-list.render-after", - "description": "A static extension target that is rendered immediately after the pickup points.", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Pickup Points", - "definitions": [ - { - "title": "PickupPointListApi", - "description": "The API object provided to this and other `pickup-point-list` extension targets.", - "type": "PickupPointListApi", - "typeDefinitions": { - "PickupPointListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "name": "PickupPointListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.pickup-point-list.render-before", - "description": "A static extension target that is rendered immediately before the pickup points.", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Pickup Points", - "definitions": [ - { - "title": "PickupPointListApi", - "description": "The API object provided to this and other `pickup-point-list` extension targets.", - "type": "PickupPointListApi", - "typeDefinitions": { - "PickupPointListApi": { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "name": "PickupPointListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", - "syntaxKind": "PropertySignature", - "name": "isLocationFormVisible", - "value": "SubscribableSignalLike", - "description": "Whether the customer location input form is shown to the buyer." - } - ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the customer location input form is shown to the buyer.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.reductions.render-after", - "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements.", - "subCategory": "Order Summary", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.reductions.render-before", - "description": "A static extension target that is rendered in the order summary, before the discount form element.", - "subCategory": "Order Summary", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useAttributeValues} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const [freeGiftRequested] = useAttributeValues([\n 'requestedFreeGift',\n ]);\n\n // 1. Render a UI\n return (\n <s-checkbox\n checked={freeGiftRequested === 'yes'}\n onChange={onCheckboxChange}\n label=\"I would like to receive a free gift with my order\"\n />\n );\n\n async function onCheckboxChange(event) {\n const isChecked = event.currentTarget.checked;\n // 2. Check if the API is available\n if (\n !shopify.instructions.value.attributes\n .canUpdateAttributes\n ) {\n console.error(\n 'Attributes cannot be updated in this checkout',\n );\n return;\n }\n // 3. Call the API to modify checkout\n const result =\n await shopify.applyAttributeChange({\n key: 'requestedFreeGift',\n type: 'updateAttribute',\n value: isChecked ? 'yes' : 'no',\n });\n console.log(\n 'applyAttributeChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.shipping-option-item.details.render", - "description": "\nA static extension target that is rendered under the shipping method within the shipping method option list, for each option.\n\n> Note:\n> - In split shipping scenarios, this target is duplicated for each delivery group (shipment), and its value is the selected shipping option for the delivery group.\n> - If you are collecting information in this target, you should consider that it needs to be scoped to a specific delivery group in split shipping scenarios. Alternatively, you can move your extension to `purchase.checkout.shipping-option-list.render-before` or `purchase.checkout.shipping-option-list.render-after`, which are not duplicated for each delivery group.\n", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.checkout.shipping-option-item.details.render", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nimport {useShippingOptionTarget} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {shippingOptionTarget, isTargetSelected} =\n useShippingOptionTarget();\n const title = shippingOptionTarget.title;\n\n return (\n <s-text>\n Shipping method: {title} is{' '}\n {isTargetSelected ? '' : 'not'} selected.\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Shipping", - "definitions": [ - { - "title": "ShippingOptionItemApi", - "description": "The API object provided to this and other `shipping-option-item` extension targets.", - "type": "ShippingOptionItemApi", - "typeDefinitions": { - "ShippingOptionItemApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the shipping option the extension is attached to is currently selected in the UI." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "renderMode", - "value": "ShippingOptionItemRenderMode", - "description": "The render mode of the shipping option." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The shipping option the extension is attached to." - } - ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the shipping option the extension is attached to is currently selected in the UI.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of the shipping option.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "ShippingOptionItemRenderMode": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemRenderMode", - "description": "The render mode of a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Whether the shipping option is rendered in an overlay." - } - ], - "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay.\n */\n overlay: boolean;\n}" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.shipping-option-item.render-after", - "description": "\nA static extension target that is rendered after the shipping method details within the shipping method option list, for each option.\n\n> Note:\n> In split shipping scenarios, this target will render within a Modal when `renderMode.overlay` is true. In this case, it is recommended to avoid using components that render an overlay such as Modals.\n", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.checkout.shipping-option-item.render-after", - "tabs": [ - { - "code": "import {render, Fragment} from 'preact';\n\nimport {useShippingOptionTarget} from '@shopify/ui-extensions/checkout/preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const {\n shippingOptionTarget,\n isTargetSelected,\n renderMode,\n } = useShippingOptionTarget();\n const {\n cost: {amount, currencyCode},\n title,\n } = shippingOptionTarget;\n\n // When the target is rendered inside the \"More shipping options\" modal for split shipping scenarios, `renderMode.overlay` is true. This check allows to render an alternative UI to avoid nested modals.\n if (renderMode.overlay) {\n return (\n <s-text>\n Shipping method: {title} is{' '}\n {isTargetSelected ? '' : 'not'} selected.\n </s-text>\n );\n }\n\n // When the target is rendered inline for both split shipping and non-split shipping scenarios, a Modal can be rendered if desired.\n return (\n <Fragment>\n <s-link\n command=\"--show\"\n commandFor=\"my-modal\"\n >\n View details ({title} is{' '}\n {isTargetSelected ? '' : 'not'} selected)\n </s-link>\n <s-modal\n id=\"my-modal\"\n heading={`Shipping option: ${title}`}\n >\n <s-paragraph>\n Cost:{' '}\n {Intl.NumberFormat(undefined, {\n style: 'currency',\n currency: currencyCode,\n }).format(amount)}\n </s-paragraph>\n <s-button\n variant=\"primary\"\n onClick={() =>\n shopify.ui.overlay.close('my-modal')\n }\n >\n Close\n </s-button>\n </s-modal>\n </Fragment>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Shipping", - "definitions": [ - { - "title": "ShippingOptionItemApi", - "description": "The API object provided to this and other `shipping-option-item` extension targets.", - "type": "ShippingOptionItemApi", - "typeDefinitions": { - "ShippingOptionItemApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "isTargetSelected", - "value": "SubscribableSignalLike", - "description": "Whether the shipping option the extension is attached to is currently selected in the UI." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "renderMode", - "value": "ShippingOptionItemRenderMode", - "description": "The render mode of the shipping option." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The shipping option the extension is attached to." - } - ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option the extension is attached to.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the shipping option the extension is attached to is currently selected in the UI.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of the shipping option.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "ShippingOptionItemRenderMode": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "name": "ShippingOptionItemRenderMode", - "description": "The render mode of a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "boolean", - "description": "Whether the shipping option is rendered in an overlay." - } - ], - "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay.\n */\n overlay: boolean;\n}" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.shipping-option-list.render-after", - "description": "A static extension target that is rendered after the shipping method options.", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.checkout.shipping-option-list.render-after", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const metafieldNamespace = 'yourAppNamespace';\n const [checked, setChecked] = useState(false);\n\n // 1. Render a UI\n if (!shopify.target.value) {\n return null;\n }\n\n const {groupType, deliveryGroups} =\n shopify.target.value;\n const metafieldKey =\n groupType === 'oneTimePurchase'\n ? 'isGift-oneTimePurchase'\n : 'isGift-subscription';\n const selectedDeliverySelectionGroup =\n shopify.deliverySelectionGroups.value?.find(\n ({selected}) => selected,\n );\n\n const groupLabel =\n groupType === 'oneTimePurchase'\n ? 'one time purchase'\n : 'subscription';\n\n const title =\n deliveryGroups.length > 1\n ? `Your order contains multiple ${groupLabel} shipments.`\n : `Your order contains one ${groupLabel} shipment.`;\n\n let deliverySelectionGroupInfo = '';\n if (selectedDeliverySelectionGroup) {\n deliverySelectionGroupInfo = ` Items will be delivered with the ${selectedDeliverySelectionGroup.title} delivery selection group.`;\n }\n\n return (\n <s-stack gap=\"base\">\n <s-banner\n tone=\"info\"\n heading={`${title}${deliverySelectionGroupInfo}`}\n />\n <s-checkbox\n onChange={onCheckboxChange}\n checked={checked}\n label={`The ${groupLabel} section contains gifts`}\n />\n </s-stack>\n );\n\n // 2. Call API methods to modify the checkout\n async function onCheckboxChange(isChecked) {\n setChecked(isChecked);\n const result =\n await shopify.applyMetafieldChange({\n type: 'updateCartMetafield',\n metafield: {\n namespace: metafieldNamespace,\n key: metafieldKey,\n value: isChecked ? 'yes' : 'no',\n type: 'single_line_text_field',\n },\n });\n console.log(\n 'applyMetafieldsChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Shipping", - "definitions": [ - { - "title": "ShippingOptionListApi", - "description": "The API object provided to this and other `shipping-option-list` extension targets.", - "type": "ShippingOptionListApi", - "typeDefinitions": { - "ShippingOptionListApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "ShippingOptionListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliverySelectionGroups", - "value": "SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >", - "description": "The list of selection groups available to the buyers. The property will be undefined when no such groups are available." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type." - } - ], - "value": "export interface ShippingOptionListApi {\n /**\n * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.\n */\n target: SubscribableSignalLike;\n /**\n * The list of selection groups available to the buyers. The property will be undefined when no such groups are available.\n */\n deliverySelectionGroups: SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "DeliverySelectionGroup": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliverySelectionGroup", - "description": "A selection group for delivery options.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "associatedDeliveryOptions", - "value": "DeliveryOptionReference[]", - "description": "The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The sum of each delivery option's cost." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The sum of each delivery option's cost after discounts." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The handle of the selection group." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "If the selection group is selected." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The localized title of the selection group." - } - ], - "value": "export interface DeliverySelectionGroup {\n /**\n * The handle of the selection group.\n */\n handle: string;\n /**\n * If the selection group is selected.\n */\n selected: boolean;\n /**\n * The localized title of the selection group.\n */\n title: string;\n /**\n * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The sum of each delivery option's cost.\n */\n cost: Money;\n /**\n * The sum of each delivery option's cost after discounts.\n */\n costAfterDiscounts: Money;\n}" - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryGroupList": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliveryGroupList", - "description": "The delivery group list the extension is associated to.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "DeliveryGroup[]", - "description": "The delivery groups that compose this list." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The group type of the delivery group list." - } - ], - "value": "export interface DeliveryGroupList {\n /**\n * The group type of the delivery group list.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups that compose this list.\n */\n deliveryGroups: DeliveryGroup[];\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.checkout.shipping-option-list.render-before", - "description": "A static extension target that is rendered between the shipping method header and shipping method options.", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.checkout.shipping-option-list.render-before", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n const metafieldNamespace = 'yourAppNamespace';\n const [checked, setChecked] = useState(false);\n\n // 1. Render a UI\n if (!shopify.target.value) {\n return null;\n }\n\n const {groupType, deliveryGroups} =\n shopify.target.value;\n const metafieldKey =\n groupType === 'oneTimePurchase'\n ? 'isGift-oneTimePurchase'\n : 'isGift-subscription';\n const selectedDeliverySelectionGroup =\n shopify.deliverySelectionGroups.value?.find(\n ({selected}) => selected,\n );\n\n const groupLabel =\n groupType === 'oneTimePurchase'\n ? 'one time purchase'\n : 'subscription';\n\n const title =\n deliveryGroups.length > 1\n ? `Your order contains multiple ${groupLabel} shipments.`\n : `Your order contains one ${groupLabel} shipment.`;\n\n let deliverySelectionGroupInfo = '';\n if (selectedDeliverySelectionGroup) {\n deliverySelectionGroupInfo = ` Items will be delivered with the ${selectedDeliverySelectionGroup.title} delivery selection group.`;\n }\n\n return (\n <s-stack gap=\"base\">\n <s-banner\n tone=\"info\"\n heading={`${title}${deliverySelectionGroupInfo}`}\n />\n <s-checkbox\n onChange={onCheckboxChange}\n checked={checked}\n label={`The ${groupLabel} section contains gifts`}\n />\n </s-stack>\n );\n\n // 2. Call API methods to modify the checkout\n async function onCheckboxChange(isChecked) {\n setChecked(isChecked);\n const result =\n await shopify.applyMetafieldChange({\n type: 'updateCartMetafield',\n metafield: {\n namespace: metafieldNamespace,\n key: metafieldKey,\n value: isChecked ? 'yes' : 'no',\n type: 'single_line_text_field',\n },\n });\n console.log(\n 'applyMetafieldsChange result',\n result,\n );\n }\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Shipping", - "definitions": [ - { - "title": "ShippingOptionListApi", - "description": "The API object provided to this and other `shipping-option-list` extension targets.", - "type": "ShippingOptionListApi", - "typeDefinitions": { - "ShippingOptionListApi": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "ShippingOptionListApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliverySelectionGroups", - "value": "SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >", - "description": "The list of selection groups available to the buyers. The property will be undefined when no such groups are available." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type." - } - ], - "value": "export interface ShippingOptionListApi {\n /**\n * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.\n */\n target: SubscribableSignalLike;\n /**\n * The list of selection groups available to the buyers. The property will be undefined when no such groups are available.\n */\n deliverySelectionGroups: SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "DeliverySelectionGroup": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliverySelectionGroup", - "description": "A selection group for delivery options.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "associatedDeliveryOptions", - "value": "DeliveryOptionReference[]", - "description": "The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The sum of each delivery option's cost." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The sum of each delivery option's cost after discounts." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The handle of the selection group." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "If the selection group is selected." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The localized title of the selection group." - } - ], - "value": "export interface DeliverySelectionGroup {\n /**\n * The handle of the selection group.\n */\n handle: string;\n /**\n * If the selection group is selected.\n */\n selected: boolean;\n /**\n * The localized title of the selection group.\n */\n title: string;\n /**\n * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The sum of each delivery option's cost.\n */\n cost: Money;\n /**\n * The sum of each delivery option's cost after discounts.\n */\n costAfterDiscounts: Money;\n}" - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "DeliveryGroupList": { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "name": "DeliveryGroupList", - "description": "The delivery group list the extension is associated to.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "DeliveryGroup[]", - "description": "The delivery groups that compose this list." - }, - { - "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The group type of the delivery group list." - } - ], - "value": "export interface DeliveryGroupList {\n /**\n * The group type of the delivery group list.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups that compose this list.\n */\n deliveryGroups: DeliveryGroup[];\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - } - } - }, - { - "title": "CheckoutApi", - "description": "The API object provided to this and other `purchase.checkout` extension targets.", - "type": "CheckoutApi", - "typeDefinitions": { - "CheckoutApi": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CheckoutApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyAttributeChange", - "value": "(change: AttributeChange) => Promise", - "description": "Performs an update on an attribute attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", - "deprecationMessage": "- Consumers should use cart metafields instead." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyCartLinesChange", - "value": "(change: CartLineChange) => Promise", - "description": "Performs an update on the merchandise line items. It resolves when the new line items have been negotiated and results in an update to the value retrieved through the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyDiscountCodeChange", - "value": "(change: DiscountCodeChange) => Promise", - "description": "Performs an update on the discount codes. It resolves when the new discount codes have been negotiated and results in an update to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyGiftCardChange", - "value": "(change: GiftCardChange) => Promise", - "description": "Performs an update on the gift cards. It resolves when gift card change have been negotiated and results in an update to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyMetafieldChange", - "value": "(change: MetafieldChange) => Promise", - "description": "Performs an update on a piece of metadata attached to the checkout. If successful, this mutation results in an update to the value retrieved through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n\nCart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyNoteChange", - "value": "(change: NoteChange) => Promise", - "description": "Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "MethodSignature", - "name": "applyShippingAddressChange", - "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the `shippingAddress` property.\n\n> Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "experimentalIsShopAppStyle", - "value": "boolean", - "description": "", - "isOptional": true, - "isPrivate": true - } - ], - "value": "export interface CheckoutApi {\n /**\n * Performs an update on an attribute attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated - Consumers should use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Performs an update on the merchandise line items. It resolves when the new\n * line items have been negotiated and results in an update to the value\n * retrieved through the\n * [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)\n * property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Performs an update on the discount codes.\n * It resolves when the new discount codes have been negotiated and results in an update\n * to the value retrieved through the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Performs an update on the gift cards.\n * It resolves when gift card change have been negotiated and results in an update\n * to the value retrieved through the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Performs an update on a piece of metadata attached to the checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.\n *\n * Cart metafields will be copied to order metafields at order creation time if there is a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Performs an update on the note attached to the cart and checkout. If\n * successful, this mutation results in an update to the value retrieved\n * through the [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Performs an update of the shipping address. Shipping address changes will\n * completely overwrite the existing shipping address added by the user without\n * any prompts. If successful, this mutation results in an update to the value\n * retrieved through the `shippingAddress` property.\n *\n * > Note: This method will return an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" - }, - "AttributeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChange", - "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "" - }, - "AttributeUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeUpdateChange", - "description": "Updates an attribute on the order. If an attribute with the provided key does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to add or update" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateAttribute'", - "description": "The type of the `AttributeUpdateChange` API." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for the attribute to add or update" - } - ], - "value": "export interface AttributeUpdateChange {\n /**\n * The type of the `AttributeUpdateChange` API.\n */\n type: 'updateAttribute';\n\n /**\n * Key of the attribute to add or update\n */\n key: string;\n\n /**\n * Value for the attribute to add or update\n */\n value: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "AttributeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeRemoveChange", - "description": "Removes an attribute on the order if an attribute with the provided key already exists.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "Key of the attribute to remove" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeAttribute'", - "description": "The type of the `AttributeRemoveChange` API." - } - ], - "value": "export interface AttributeRemoveChange {\n /**\n * The type of the `AttributeRemoveChange` API.\n */\n type: 'removeAttribute';\n\n /**\n * Key of the attribute to remove\n */\n key: string;\n}" - }, - "AttributeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AttributeChangeResult", - "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "" - }, - "AttributeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultSuccess", - "description": "The returned result of a successful update to an attribute.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `AttributeChangeResultSuccess` API." - } - ], - "value": "export interface AttributeChangeResultSuccess {\n /**\n * The type of the `AttributeChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "AttributeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "AttributeChangeResultError", - "description": "The returned result of an unsuccessful update to an attribute with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `AttributeChangeResultError` API." - } - ], - "value": "export interface AttributeChangeResultError {\n /**\n * The type of the `AttributeChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "CartLineChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChange", - "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "" - }, - "CartLineAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The attributes associated with the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The merchandise ID being added.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being added." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "string", - "description": "The identifier of the selling plan that the merchandise is being purchased with.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addCartLine'", - "description": "An identifier for changes that add line items." - } - ], - "value": "export interface CartLineAddChange {\n /**\n * An identifier for changes that add line items.\n */\n type: 'addCartLine';\n\n /**\n * The merchandise ID being added.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The quantity of the merchandise being added.\n */\n quantity: number;\n\n /**\n * The attributes associated with the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "CartLineRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity being removed for this line item." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartLine'", - "description": "An identifier for changes that remove line items." - } - ], - "value": "export interface CartLineRemoveChange {\n /**\n * An identifier for changes that remove line items.\n */\n type: 'removeCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The quantity being removed for this line item.\n */\n quantity: number;\n}" - }, - "CartLineUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The new attributes for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Line Item ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "merchandiseId", - "value": "string", - "description": "The new merchandise ID for the line item.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{lineId: string} | {merchandiseId: string}", - "description": "The identifier for the associated parent cart line.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The new quantity for the line item.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlanId", - "value": "SellingPlan['id'] | null", - "description": "The identifier of the selling plan that the merchandise is being purchased with or `null` to remove the the product from the selling plan.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartLine'", - "description": "An identifier for changes that update line items." - } - ], - "value": "export interface CartLineUpdateChange {\n /**\n * An identifier for changes that update line items.\n */\n type: 'updateCartLine';\n\n /**\n * Line Item ID.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new merchandise ID for the line item.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for the line item.\n */\n quantity?: number;\n\n /**\n * The new attributes for the line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the selling plan that the merchandise is being purchased\n * with or `null` to remove the the product from the selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The identifier for the associated parent cart line.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" - }, - "CartLineChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartLineChangeResult", - "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "" - }, - "CartLineChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the line item was changed successfully." - } - ], - "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the line item was changed successfully.\n */\n type: 'success';\n}" - }, - "CartLineChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "CartLineChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error." - } - ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "DiscountCodeChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChange", - "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "" - }, - "DiscountCodeAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeAddChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'addDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount (case-insensitive)" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeDiscountCode'", - "description": "The type of the `DiscountCodeChange` API." - } - ], - "value": "export interface DiscountCodeRemoveChange {\n /**\n * The type of the `DiscountCodeChange` API.\n */\n type: 'removeDiscountCode';\n\n /**\n * The code for the discount (case-insensitive)\n */\n code: string;\n}" - }, - "DiscountCodeChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DiscountCodeChangeResult", - "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "" - }, - "DiscountCodeChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the discount code change was applied successfully." - } - ], - "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" - }, - "DiscountCodeChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "DiscountCodeChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the discount code change failed." - } - ], - "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "GiftCardChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChange", - "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "" - }, - "GiftCardAddChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardAddChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "Gift card code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'addGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardAddChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'addGiftCard';\n\n /**\n * Gift card code.\n */\n code: string;\n}" - }, - "GiftCardRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardRemoveChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The full gift card code, or the last four digits of the code." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeGiftCard'", - "description": "The type of the `GiftCardChange` API." - } - ], - "value": "export interface GiftCardRemoveChange {\n /**\n * The type of the `GiftCardChange` API.\n */\n type: 'removeGiftCard';\n\n /**\n * The full gift card code, or the last four digits of the code.\n */\n code: string;\n}" - }, - "GiftCardChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "GiftCardChangeResult", - "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "" - }, - "GiftCardChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the gift card change was applied successfully." - } - ], - "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" - }, - "GiftCardChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "GiftCardChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the gift card change failed." - } - ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change failed.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MetafieldChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChange", - "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "" - }, - "MetafieldRemoveCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldRemoveCartChange", - "description": "Removes a cart metafield.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield to remove." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace of the metafield to remove.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeCartMetafield'", - "description": "The type of the `MetafieldRemoveCartChange` API." - } - ], - "value": "export interface MetafieldRemoveCartChange {\n /**\n * The type of the `MetafieldRemoveCartChange` API.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" - }, - "CartMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - } - ], - "value": "export interface CartMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /** The namespace for a metafield. */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "MetafieldUpdateCartChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldUpdateCartChange", - "description": "Updates a cart metafield. If a metafield with the provided key and namespace does not already exist, it gets created.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "{ key: string; namespace?: string; value: string; type: string; }", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateCartMetafield'", - "description": "The type of the `MetafieldUpdateCartChange` API." - } - ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * The type of the `MetafieldUpdateCartChange` API.\n */\n type: 'updateCartMetafield';\n\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to add. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [`metafields documentation`](/docs/apps/custom-data/metafields/types) for a list of supported types.\n */\n type: string;\n };\n}" - }, - "MetafieldChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MetafieldChangeResult", - "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "" - }, - "MetafieldChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `MetafieldChangeResultSuccess` API." - } - ], - "value": "export interface MetafieldChangeResultSuccess {\n /**\n * The type of the `MetafieldChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "MetafieldChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "MetafieldChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `MetafieldChangeResultError` API." - } - ], - "value": "export interface MetafieldChangeResultError {\n /**\n * The type of the `MetafieldChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "NoteChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChange", - "value": "NoteRemoveChange | NoteUpdateChange", - "description": "" - }, - "NoteRemoveChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteRemoveChange", - "description": "Removes a note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'removeNote'", - "description": "The type of the `NoteRemoveChange` API." - } - ], - "value": "export interface NoteRemoveChange {\n /**\n * The type of the `NoteRemoveChange` API.\n */\n type: 'removeNote';\n}" - }, - "NoteUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteUpdateChange", - "description": "An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "string", - "description": "The new value of the note." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateNote'", - "description": "The type of the `NoteUpdateChange` API." - } - ], - "value": "export interface NoteUpdateChange {\n /**\n * The type of the `NoteUpdateChange` API.\n */\n type: 'updateNote';\n /**\n * The new value of the note.\n */\n note: string;\n}" - }, - "NoteChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "NoteChangeResult", - "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "" - }, - "NoteChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultSuccess", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `NoteChangeResultSuccess` API." - } - ], - "value": "export interface NoteChangeResultSuccess {\n /**\n * The type of the `NoteChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "NoteChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "NoteChangeResultError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `NoteChangeResultError` API." - } - ], - "value": "export interface NoteChangeResultError {\n /**\n * The type of the `NoteChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "ShippingAddressUpdateChange": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressUpdateChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "Partial", - "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update — any fields you do not list will keep their current values." - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'updateShippingAddress'", - "description": "The type of the `ShippingAddressUpdateChange` API." - } - ], - "value": "export interface ShippingAddressUpdateChange {\n /**\n * The type of the `ShippingAddressUpdateChange` API.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update — any fields you do not list\n * will keep their current values.\n */\n address: Partial;\n}" - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "ShippingAddressChangeResult": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShippingAddressChangeResult", - "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "" - }, - "ShippingAddressChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultSuccess", - "description": "The returned result of a successful update to the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "null", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `ShippingAddressChangeResultSuccess` API." - } - ], - "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * The type of the `ShippingAddressChangeResultSuccess` API.\n */\n type: 'success';\n\n errors: null;\n}" - }, - "ShippingAddressChangeResultError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeResultError", - "description": "The returned result of an update to the shipping address with a messages detailing the type of errors that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ShippingAddressChangeFieldError[]", - "description": "The errors corresponding to particular fields from a given change" - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `ShippingAddressChangeResultError` API." - } - ], - "value": "export interface ShippingAddressChangeResultError {\n /**\n * The type of the `ShippingAddressChangeResultError` API.\n */\n type: 'error';\n\n /**\n * The errors corresponding to particular fields from a given change\n */\n errors: ShippingAddressChangeFieldError[];\n}" - }, - "ShippingAddressChangeFieldError": { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "name": "ShippingAddressChangeFieldError", - "description": "An error corresponding to a particular field from a given change", - "members": [ - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "field", - "value": "keyof MailingAddress", - "description": "field key from MailingAddress where the error occurred", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - } - ], - "value": "export interface ShippingAddressChangeFieldError {\n /**\n * field key from MailingAddress where the error occurred\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.announcement.render", - "description": "A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.", - "defaultExample": { - "description": "", - "codeblock": { - "title": " purchase.thank-you.announcement.render", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-announcement>\n <s-stack direction=\"inline\" gap=\"base\">\n <s-text>Check our latest offers</s-text>\n <s-link\n commandFor=\"survey-modal\"\n command=\"--show\"\n >\n Fill out the survey\n </s-link>\n </s-stack>\n <s-modal\n id=\"survey-modal\"\n heading=\"Tell us about your shopping experience\"\n >\n <s-stack gap=\"base\">\n <s-text>\n We’d love to hear about your shopping\n experience\n </s-text>\n <s-text-area\n rows=\"4\"\n label=\"How can we make your shopping experience better?\"\n />\n <s-button>Submit</s-button>\n </s-stack>\n </s-modal>\n </s-announcement>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "subCategory": "Announcement", - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.block.render", - "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/docs/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\n The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", - "subCategory": "Block", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.cart-line-item.render-after", - "description": "A static extension target that renders on every line item, inside the details under the line item properties element.\n\n > Caution:\n > This extension target will not be rendered if the line item is a custom line item belonging to a draft order invoice.\n ", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-text>\n Line item title:{' '}\n {shopify.target.value.merchandise.title}\n </s-text>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "subCategory": "Order Summary", - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "CartLineItemApi", - "description": "The API object provided to this and other `cart-line-item` extension targets.", - "type": "CartLineItemApi", - "typeDefinitions": { - "CartLineItemApi": { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "name": "CartLineItemApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`." - } - ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.cart-line-list.render-after", - "description": "A static extension target that is rendered after all line items on the **Thank you** page.", - "subCategory": "Order Summary", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.customer-information.render-after", - "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.", - "subCategory": "Information", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.footer.render-after", - "description": "A static extension target that is rendered below the footer on the **Thank you** page.\n\n > Tip:\n > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading.\n > See: [Spinner](/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](/docs/api/checkout-ui-extensions/components/structure/blockspacer).\n ", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "subCategory": "Footer", - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "purchase.thank-you.header.render-after", - "description": "A static extension target that is rendered below the header on the **Thank you** page.\n\n > Tip:\n > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading.\n > See: [Spinner](/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](/docs/api/checkout-ui-extensions/components/structure/blockspacer).\n ", - "defaultExample": { - "description": "", - "codeblock": { - "title": "", - "tabs": [ - { - "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n render(<Extension />, document.body);\n}\n\nfunction Extension() {\n return (\n <s-stack gap=\"base\">\n <s-paragraph>\n Shop name: {shopify.shop.name}\n </s-paragraph>\n <s-paragraph>\n cost:{' '}\n {shopify.cost.totalAmount.value.amount}\n </s-paragraph>\n </s-stack>\n );\n}\n", - "language": "jsx", - "title": "Preact" - } - ] - } - }, - "subCategory": "Header", - "related": [ - { - "name": "APIs", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/targets", - "type": "blocks" - }, - { - "name": "Components", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/components", - "type": "apps" - }, - { - "name": "Configuration", - "subtitle": "Reference", - "url": "/docs/api/checkout-ui-extensions/configuration", - "type": "gear" - }, - { - "name": "Tutorials", - "subtitle": "Learn", - "url": "/apps/checkout", - "type": "tutorial" - } - ], - "definitions": [ - { - "title": "OrderConfirmationApi", - "description": "The API object provided to this and other `purchase.thank-you` extension targets.", - "type": "OrderConfirmationApi", - "typeDefinitions": { - "OrderConfirmationApi": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmationApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "orderConfirmation", - "value": "SubscribableSignalLike", - "description": "Order information that's available post-checkout." - } - ], - "value": "export interface OrderConfirmationApi {\n /**\n * Order information that's available post-checkout.\n */\n orderConfirmation: SubscribableSignalLike;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "OrderConfirmation": { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "name": "OrderConfirmation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "isFirstOrder", - "value": "boolean", - "description": "Whether this is the customer's first order." - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "number", - "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "{ id: string; }", - "description": "" - } - ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order.\n * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first order.\n */\n isFirstOrder: boolean;\n}" - } - } - }, - { - "title": "StandardApi", - "description": "The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.", - "type": "StandardApi", - "typeDefinitions": { - "StandardApi": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StandardApi", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "Gift Cards that have been applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Allows setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "availablePaymentOptions", - "value": "SubscribableSignalLike", - "description": "All available payment options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "BuyerIdentity", - "description": "Information about the buyer that is interacting with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "buyerJourney", - "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) examples for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "Settings applied to the buyer's checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutToken", - "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "Details on the costs the buyer will pay for this checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryGroups", - "value": "SubscribableSignalLike", - "description": "A list of delivery groups containing information about the delivery of the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "Discounts that have been applied to the entire cart." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes currently applied to the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "The meta information about the extension." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "instructions", - "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked prior to performing any actions that may be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of lines containing information about the items the customer intends to purchase." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "localizedFields", - "value": "SubscribableSignalLike", - "description": "The API for reading additional fields that are required in checkout under certain circumstances. For example, some countries require additional fields for customs information or tax identification numbers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedPaymentOptions", - "value": "SubscribableSignalLike", - "description": "Payment options selected by the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the checkout is taking place." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ui", - "value": "Ui", - "description": "Methods to interact with the extension’s UI." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The renderer version being used for the extension.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2025-10'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * Gift Cards that have been applied to the checkout.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked prior to performing any actions that may be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available.\n * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All available payment options.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that is interacting with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * Details on the costs the buyer will pay for this checkout.\n */\n cost: CartCost;\n\n /**\n * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * A list of discount codes currently applied to the checkout.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * Discounts that have been applied to the entire cart.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * A list of lines containing information about the items the customer intends to purchase.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * Payment options selected by the buyer.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings will be empty until\n * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * An address value is only present if delivery is required. Otherwise, the\n * subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * Methods to interact with the extension’s UI.\n */\n ui: Ui;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Allows setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * The API for reading additional fields that are required in checkout under certain circumstances.\n * For example, some countries require additional fields for customs information or tax identification numbers.\n */\n localizedFields?: SubscribableSignalLike;\n}" - }, - "Analytics": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Analytics", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "publish", - "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "visitor", - "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." - } - ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" - }, - "VisitorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "VisitorResult", - "value": "VisitorSuccess | VisitorError", - "description": "Represents a visitor result." - }, - "VisitorSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorSuccess", - "description": "Represents a successful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "Indicates that the visitor information was validated and submitted." - } - ], - "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" - }, - "VisitorError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorError", - "description": "Represents an unsuccessful visitor result.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." - } - ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It's **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "SubscribableSignalLike": { - "filePath": "src/surfaces/checkout/shared.ts", - "name": "SubscribableSignalLike", - "description": "Represents a read-only value managed on the main thread that an extension can subscribe to.\n\nExample: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker.\n\nThis interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).\n\nSome fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.", - "members": [ - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "T", - "description": "", - "deprecationMessage": "Use `.value` instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "destroy", - "value": "() => Promise", - "description": "", - "deprecationMessage": "No longer needed. Use Preact Signal management instead." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "MethodSignature", - "name": "subscribe", - "value": "(fn: (value: T) => void) => () => void", - "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." - }, - { - "filePath": "src/surfaces/checkout/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "T", - "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." - } - ], - "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * @deprecated No longer needed. Use Preact Signal management instead.\n */\n destroy(): Promise;\n}" - }, - "AppliedGiftCard": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppliedGiftCard", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amountUsed", - "value": "Money", - "description": "The amount of the applied gift card that will be used when the checkout is completed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the applied gift card prior to checkout completion." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastCharacters", - "value": "string", - "description": "The last four characters of the applied gift card's code." - } - ], - "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that will be used when the checkout is completed.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card prior to checkout completion.\n */\n balance: Money;\n}" - }, - "Money": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Money", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "amount", - "value": "number", - "description": "The price amount." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currencyCode", - "value": "CurrencyCode", - "description": "The ISO 4217 format for the currency.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CAD' for Canadian dollar", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Money {\n /**\n * The price amount.\n */\n amount: number;\n /**\n * The ISO 4217 format for the currency.\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" - }, - "CurrencyCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CurrencyCode", - "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", - "description": "" - }, - "ApplyTrackingConsentChangeType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ApplyTrackingConsentChangeType", - "description": "", - "params": [ - { - "name": "visitorConsent", - "description": "", - "value": "VisitorConsentChange", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "Promise", - "value": "Promise" - }, - "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" - }, - "VisitorConsentChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsentChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafieldChange[]", - "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield will be deleted.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'changeVisitorConsent'", - "description": "" - } - ], - "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield will be deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n type: 'changeVisitorConsent';\n}" - }, - "TrackingConsentMetafieldChange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafieldChange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | null", - "description": "The information to be stored as metadata. If the value is `null`, the metafield will be deleted.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', `null`, or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata. If the value is `null`, the metafield will be deleted.\n *\n * @example 'any string', `null`, or a stringified JSON object\n */\n value: string | null;\n}" - }, - "VisitorConsent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "VisitorConsent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Visitor consents to recording data to understand how customers interact with the site.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Visitor consents to ads and marketing communications based on customer interests.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Opts the visitor out of data sharing / sales.", - "isOptional": true - } - ], - "value": "export interface VisitorConsent {\n /**\n * Visitor consents to recording data to understand how customers interact with the site.\n */\n analytics?: boolean;\n /**\n * Visitor consents to ads and marketing communications based on customer interests.\n */\n marketing?: boolean;\n /**\n * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website.\n */\n preferences?: boolean;\n /**\n * Opts the visitor out of data sharing / sales.\n */\n saleOfData?: boolean;\n}" - }, - "TrackingConsentChangeResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "TrackingConsentChangeResult", - "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "" - }, - "TrackingConsentChangeResultSuccess": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultSuccess", - "description": "The returned result of a successful tracking consent preference update.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'success'", - "description": "The type of the `TrackingConsentChangeResultSuccess` API." - } - ], - "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * The type of the `TrackingConsentChangeResultSuccess` API.\n */\n type: 'success';\n}" - }, - "TrackingConsentChangeResultError": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentChangeResultError", - "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'error'", - "description": "The type of the `TrackingConsentChangeResultError` API." - } - ], - "value": "export interface TrackingConsentChangeResultError {\n /**\n * The type of the `TrackingConsentChangeResultError` API.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" - }, - "AppMetafieldEntry": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntry", - "description": "A metafield associated with the shop or a resource on the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafield", - "value": "AppMetafield", - "description": "The metadata information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "AppMetafieldEntryTarget", - "description": "The target that is associated to the metadata.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntry {\n /**\n * The target that is associated to the metadata.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /** The metadata information. */\n metafield: AppMetafield;\n}" - }, - "AppMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafield", - "description": "Represents a custom metadata attached to a resource.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key name of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "The namespace for a metafield.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "string", - "description": "The metafield's type name." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of a metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface AppMetafield {\n /** The key name of a metafield. */\n key: string;\n\n /**\n * The namespace for a metafield.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /** The value of a metafield. */\n value: string;\n\n /** The metafield’s information type. */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /** The metafield's type name. */\n type: string;\n}" - }, - "AppMetafieldEntryTarget": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AppMetafieldEntryTarget", - "description": "The metafield owner.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The numeric owner ID that is associated with the metafield." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The type of the metafield owner.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." - } - ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The type of the metafield owner.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /** The numeric owner ID that is associated with the metafield. */\n id: string;\n}" - }, - "Attribute": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "Attribute", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The key for the attribute." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value for the attribute." - } - ], - "value": "export interface Attribute {\n /**\n * The key for the attribute.\n */\n key: string;\n\n /**\n * The value for the attribute.\n */\n value: string;\n}" - }, - "PaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentOption", - "description": "A payment option presented to the buyer.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ], - "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment that will be collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * The unique handle for the payment option.\n *\n * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.\n */\n handle: string;\n}" - }, - "MailingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "MailingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the buyer's address, including street name and number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, like apartment number, suite, etc.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The buyer's city.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The buyer's postal or ZIP code.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The buyer's phone number.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'.\n */\n phone?: string;\n}" - }, - "CountryCode": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CountryCode", - "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", - "description": "" - }, - "BuyerIdentity": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerIdentity", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account. The value is undefined if the buyer isn’t a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "Provides details of the company and the company location that the business customer is purchasing on behalf of. This includes information that can be used to identify the company and the company location that the business customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account. The value is undefined if the buyer isn’t a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number of the buyer that is interacting with the cart.\n * The value is `undefined` if the app does not have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * Provides details of the company and the company location that the business customer is purchasing on behalf of.\n * This includes information that can be used to identify the company and the company location that the business\n * customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" - }, - "Customer": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsEmailMarketing", - "value": "boolean", - "description": "Defines if the customer accepts email marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Defines if the customer email accepts marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", - "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsSmsMarketing", - "value": "boolean", - "description": "Defines if the customer accepts SMS marketing activities.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The first name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The full name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Customer ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Customer/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The image associated with the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The last name of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "ordersCount", - "value": "number", - "description": "The number of previous orders made by this customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number of the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The Store Credit Accounts owned by the customer and usable during the checkout process.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isPrivate": true - } - ], - "value": "export interface Customer {\n /**\n * Customer ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The full name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The first name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The last name of the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The image associated with the customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Defines if the customer email accepts marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Defines if the customer accepts email marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Defines if the customer accepts SMS marketing activities.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The Store Credit Accounts owned by the customer and usable during the checkout process.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of previous orders made by this customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" - }, - "ImageDetails": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ImageDetails", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "altText", - "value": "string", - "description": "The alternative text for the image.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The image URL." - } - ], - "value": "export interface ImageDetails {\n /**\n * The image URL.\n */\n url: string;\n\n /**\n * The alternative text for the image.\n */\n altText?: string;\n}" - }, - "StoreCreditAccount": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "StoreCreditAccount", - "description": "Information about a Store Credit Account.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "balance", - "value": "Money", - "description": "The current balance of the Store Credit Account." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/StoreCreditAccount/1'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The current balance of the Store Credit Account.\n */\n balance: Money;\n}" - }, - "PurchasingCompany": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PurchasingCompany", - "description": "The information about a company that the business customer is purchasing on behalf of.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "Company", - "description": "Includes information of the company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "CompanyLocation", - "description": "Includes information of the company location that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface PurchasingCompany {\n /**\n * Includes information of the company that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * Includes information of the company location that the business customer is purchasing on behalf of.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" - }, - "Company": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Company", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface Company {\n /**\n * The company ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "CompanyLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CompanyLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "The external ID of the company location that can be set by the merchant.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The company location ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - } - ], - "value": "export interface CompanyLocation {\n /**\n * The company location ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n id: string;\n /**\n * The name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * The external ID of the company location that can be set by the merchant.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" - }, - "BuyerJourney": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "activeStep", - "value": "SubscribableSignalLike", - "description": "What step of checkout the buyer is currently on." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "completed", - "value": "SubscribableSignalLike", - "description": "This subscribable value will be true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "intercept", - "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function will remove the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "steps", - "value": "SubscribableSignalLike", - "description": "All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration." - } - ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function will remove the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension\n * to block checkout progress.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * This subscribable value will be true if the buyer completed submitting their order.\n *\n * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * What step of checkout the buyer is currently on.\n */\n activeStep: SubscribableSignalLike;\n}" - }, - "BuyerJourneyStepReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStepReference", - "description": "What step of checkout the buyer is currently on.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - } - ], - "value": "interface BuyerJourneyStepReference {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n}" - }, - "BuyerJourneyStepHandle": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BuyerJourneyStepHandle", - "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", - "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" - }, - "Interceptor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Interceptor", - "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.", - "params": [ - { - "name": "interceptorProps", - "description": "", - "value": "InterceptorProps", - "filePath": "src/surfaces/checkout/api/standard/standard.ts" - } - ], - "returns": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "description": "", - "name": "InterceptorRequest | Promise", - "value": "InterceptorRequest | Promise" - }, - "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" - }, - "InterceptorProps": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canBlockProgress", - "value": "boolean", - "description": "Whether the interceptor has the capability to block a buyer's progress through checkout. This ability might be granted by a merchant in differing checkout contexts." - } - ], - "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor has the capability to block a buyer's progress through\n * checkout. This ability might be granted by a merchant in differing checkout contexts.\n */\n canBlockProgress: boolean;\n}" - }, - "InterceptorRequest": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorRequest", - "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "" - }, - "InterceptorRequestAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the interceptor will allow the buyer's journey to continue." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - } - ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor will allow the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "InterceptorResult": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "InterceptorResult", - "value": "InterceptorResultAllow | InterceptorResultBlock", - "description": "" - }, - "InterceptorResultAllow": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultAllow", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'allow'", - "description": "Indicates that the buyer was allowed to progress through checkout." - } - ], - "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" - }, - "InterceptorResultBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorResultBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer’s progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." - } - ], - "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer’s progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" - }, - "InterceptorRequestBlock": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "InterceptorRequestBlock", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "behavior", - "value": "'block'", - "description": "Indicates that the interceptor will block the buyer's journey from continuing." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "errors", - "value": "ValidationError[]", - "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "perform", - "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "reason", - "value": "string", - "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify’s own internal debugging and metrics." - } - ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor will block the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" - }, - "ValidationError": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ValidationError", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "Error message to be displayed to the buyer." - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "string", - "description": "The checkout UI field that the error is associated with.\n\nExample: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) for more information.", - "isOptional": true - } - ], - "value": "export interface ValidationError {\n /**\n * Error message to be displayed to the buyer.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with.\n *\n * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode`\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" - }, - "BuyerJourneyStep": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "BuyerJourneyStep", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n\nFor example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "BuyerJourneyStepHandle", - "description": "The handle that uniquely identifies the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "The localized label of the buyer journey step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "to", - "value": "string", - "description": "The url of the buyer journey step. This property leverages the `shopify:` protocol E.g. `shopify:cart` or `shopify:checkout/information`." - } - ], - "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step.\n */\n label: string;\n /**\n * The url of the buyer journey step. This property leverages the `shopify:` protocol\n * E.g. `shopify:cart` or `shopify:checkout/information`.\n */\n to: string;\n /**\n * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet.\n *\n * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled.\n */\n disabled: boolean;\n}" - }, - "CheckoutSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CheckoutSettings", - "description": "Settings describing the behavior of the buyer's checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "orderSubmission", - "value": "'DRAFT_ORDER' | 'ORDER'", - "description": "The type of order that will be created once the buyer completes checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "paymentTermsTemplate", - "value": "PaymentTermsTemplate", - "description": "Represents the merchant configured payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address." - } - ], - "value": "export interface CheckoutSettings {\n /**\n * The type of order that will be created once the buyer completes checkout.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * Represents the merchant configured payment terms.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings describing the behavior of the shipping address.\n */\n shippingAddress: ShippingAddressSettings;\n}" - }, - "PaymentTermsTemplate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PaymentTermsTemplate", - "description": "Represents the payment terms template object.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueDate", - "value": "string", - "description": "The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "dueInDays", - "value": "number", - "description": "The number of days between the issued date and due date if using net payment terms.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/PaymentTermsTemplate/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization)." - } - ], - "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique ID.\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization).\n */\n name: string;\n /**\n * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.\n */\n dueDate?: string;\n /**\n * The number of days between the issued date and due date if using net payment terms.\n */\n dueInDays?: number;\n}" - }, - "ShippingAddressSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingAddressSettings", - "description": "Settings describing the behavior of the shipping address.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isEditable", - "value": "boolean", - "description": "Describes whether the buyer can ship to any address during checkout." - } - ], - "value": "export interface ShippingAddressSettings {\n /**\n * Describes whether the buyer can ship to any address during checkout.\n */\n isEditable: boolean;\n}" - }, - "CheckoutToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CheckoutToken", - "value": "string", - "description": "" - }, - "CartCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtotalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalShippingAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalTaxAmount", - "value": "SubscribableSignalLike", - "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable." - } - ], - "value": "export interface CartCost {\n /**\n * A `Money` value representing the subtotal value of the items in the cart at the current\n * step of checkout.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total shipping a buyer can expect to pay at the current\n * step of checkout. This value includes shipping discounts. Returns undefined if shipping\n * has not been negotiated yet, such as on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the total tax a buyer can expect to pay at the current\n * step of checkout or the total tax included in product and shipping prices. Returns\n * undefined if taxes are unavailable.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * A `Money` value representing the minimum a buyer can expect to pay at the current\n * step of checkout. This value excludes amounts yet to be negotiated. For example,\n * the information step might not have delivery costs calculated.\n */\n totalAmount: SubscribableSignalLike;\n}" - }, - "CustomerPrivacy": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacy", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "allowedProcessing", - "value": "AllowedProcessing", - "description": "An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "TrackingConsentMetafield[]", - "description": "Stored tracking consent metafield data.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "region", - "value": "CustomerPrivacyRegion", - "description": "Details about the visitor's current location for use in evaluating if more granular consent controls should render.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfDataRegion", - "value": "boolean", - "description": "Whether the visitor is in a region requiring data sale opt-outs." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "shouldShowBanner", - "value": "boolean", - "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "visitorConsent", - "value": "VisitorConsent", - "description": "An object containing the customer's current privacy consent settings. *", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacy {\n /**\n * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * Stored tracking consent metafield data.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * An object containing the customer's current privacy consent settings.\n * *\n * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision.\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is in a region requiring data sale opt-outs.\n */\n saleOfDataRegion: boolean;\n /**\n * Details about the visitor's current location for use in evaluating if more granular consent controls should render.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" - }, - "AllowedProcessing": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AllowedProcessing", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "boolean", - "description": "Can collect customer analytics about how the shop was used and interactions made on the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "marketing", - "value": "boolean", - "description": "Can collect customer preference for marketing, attribution and targeted advertising from the merchant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "preferences", - "value": "boolean", - "description": "Can collect customer preferences such as language, currency, size, and more." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "saleOfData", - "value": "boolean", - "description": "Can collect customer preference for sharing data with third parties, usually for behavioral advertising." - } - ], - "value": "export interface AllowedProcessing {\n /**\n * Can collect customer analytics about how the shop was used and interactions made on the shop.\n */\n analytics: boolean;\n /**\n * Can collect customer preference for marketing, attribution and targeted advertising from the merchant.\n */\n marketing: boolean;\n /**\n * Can collect customer preferences such as language, currency, size, and more.\n */\n preferences: boolean;\n /**\n * Can collect customer preference for sharing data with third parties, usually for behavioral advertising.\n */\n saleOfData: boolean;\n}" - }, - "TrackingConsentMetafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "TrackingConsentMetafield", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The information to be stored as metadata.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'any string', '', or a stringified JSON object", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface TrackingConsentMetafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n /**\n * The information to be stored as metadata.\n *\n * @example 'any string', '', or a stringified JSON object\n */\n value: string;\n}" - }, - "CustomerPrivacyRegion": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CustomerPrivacyRegion", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\nProvince codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed.\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province code, such as state, province, prefecture, or region.\n *\n * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2).\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected.\n */\n provinceCode?: string;\n}" - }, - "DeliveryGroup": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryGroup", - "description": "Represents the delivery information and options available for one or more cart lines.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryOptions", - "value": "DeliveryOption[]", - "description": "The delivery options available for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "groupType", - "value": "DeliveryGroupType", - "description": "The type of the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the delivery group. On the Thank You page this value is undefined.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isDeliveryRequired", - "value": "boolean", - "description": "Whether delivery is required for the delivery group." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedDeliveryOption", - "value": "DeliveryOptionReference", - "description": "The selected delivery option for the delivery group.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "targetedCartLines", - "value": "CartLineReference[]", - "description": "The cart line references associated to the delivery group." - } - ], - "value": "export interface DeliveryGroup {\n /**\n * The unique identifier of the delivery group. On the Thank You page this value is undefined.\n */\n id?: string;\n /**\n * The cart line references associated to the delivery group.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for the delivery group.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The selected delivery option for the delivery group.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * The type of the delivery group.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether delivery is required for the delivery group.\n */\n isDeliveryRequired: boolean;\n}" - }, - "DeliveryOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryOption", - "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "" - }, - "ShippingOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOption", - "description": "Represents a delivery option that is a shipping option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "ShippingOptionCarrier", - "description": "Information about the carrier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost of the delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost of the delivery including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "deliveryEstimate", - "value": "DeliveryEstimate", - "description": "Information about the estimated delivery time." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'shipping' | 'local'", - "description": "The type of this delivery option." - } - ], - "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of the delivery.\n */\n cost: Money;\n\n /**\n * The cost of the delivery including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * Information about the estimated delivery time.\n */\n deliveryEstimate: DeliveryEstimate;\n}" - }, - "ShippingOptionCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "ShippingOptionCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "export interface ShippingOptionCarrier {\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "DeliveryEstimate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryEstimate", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timeInTransit", - "value": "NumberRange", - "description": "The estimated time in transit for the delivery in seconds.", - "isOptional": true - } - ], - "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery in seconds.\n */\n timeInTransit?: NumberRange;\n}" - }, - "NumberRange": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NumberRange", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lower", - "value": "number", - "description": "The lower bound of the number range.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "upper", - "value": "number", - "description": "The upper bound of the number range.", - "isOptional": true - } - ], - "value": "export interface NumberRange {\n /**\n * The lower bound of the number range.\n */\n lower?: number;\n\n /**\n * The upper bound of the number range.\n */\n upper?: number;\n}" - }, - "Metafield": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Metafield", - "description": "Metadata associated with the checkout.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "string", - "description": "The name of the metafield. It must be between 3 and 30 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "namespace", - "value": "string", - "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. This must be between 2 and 20 characters in length (inclusive)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string | number", - "description": "The information to be stored as metadata. Always stored as a string, regardless of the metafield's type." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "valueType", - "value": "'integer' | 'string' | 'json_string'", - "description": "The metafield’s information type." - } - ], - "value": "export interface Metafield {\n /**\n * The name of the metafield. It must be between 3 and 30 characters in\n * length (inclusive).\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps. This must be between 2 and 20 characters in length (inclusive).\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type.\n */\n value: string | number;\n\n /** The metafield’s information type. */\n valueType: 'integer' | 'string' | 'json_string';\n}" - }, - "PickupPointOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "carrier", - "value": "PickupPointCarrier", - "description": "Information about the carrier that ships to the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "Money", - "description": "The cost to ship to this pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "costAfterDiscounts", - "value": "Money", - "description": "The cost to ship to this pickup point including discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupPointLocation", - "description": "The location details of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickupPoint'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships to the pickup point.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost to ship to this pickup point.\n */\n cost: Money;\n\n /**\n * The cost to ship to this pickup point including discounts.\n */\n costAfterDiscounts: Money;\n\n /**\n * The location details of the pickup point.\n */\n location: PickupPointLocation;\n}" - }, - "PickupPointCarrier": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointCarrier", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code identifying the carrier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the carrier.", - "isOptional": true - } - ], - "value": "interface PickupPointCarrier {\n /**\n * The code identifying the carrier.\n */\n code?: string;\n\n /**\n * The name of the carrier.\n */\n name?: string;\n}" - }, - "PickupPointLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupPointLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the pickup point." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup point.", - "isOptional": true - } - ], - "value": "interface PickupPointLocation {\n /**\n * The name of the pickup point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The address of the pickup point.\n */\n address: MailingAddress;\n}" - }, - "PickupLocationOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocationOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "The description of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "PickupLocation", - "description": "The location details of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "Metafield[]", - "description": "The metafields associated with this delivery option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the delivery option.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'pickup'", - "description": "The type of this delivery option." - } - ], - "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * The type of this delivery option.\n */\n type: 'pickup';\n\n /**\n * The location details of the pickup location.\n */\n location: PickupLocation;\n}" - }, - "PickupLocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "PickupLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "address", - "value": "MailingAddress", - "description": "The address of the pickup location." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the pickup location.", - "isOptional": true - } - ], - "value": "interface PickupLocation {\n /**\n * The name of the pickup location.\n */\n name?: string;\n\n /**\n * The address of the pickup location.\n */\n address: MailingAddress;\n}" - }, - "DeliveryGroupType": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "DeliveryGroupType", - "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group." - }, - "DeliveryOptionReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryOptionReference", - "description": "Represents a reference to a delivery option.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique identifier of the referenced delivery option." - } - ], - "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option.\n */\n handle: string;\n}" - }, - "CartLineReference": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineReference", - "description": "Represents a reference to a cart line.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The unique identifier of the referenced cart line." - } - ], - "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line.\n */\n id: string;\n}" - }, - "CartDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CartDiscountAllocation", - "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "" - }, - "CartCodeDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCodeDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'code'", - "description": "The type of the code discount" - } - ], - "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The code for the discount\n */\n code: string;\n\n /**\n * The type of the code discount\n */\n type: 'code';\n}" - }, - "CartAutomaticDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartAutomaticDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the automatic discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'automatic'", - "description": "The type of the automatic discount" - } - ], - "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the automatic discount\n */\n title: string;\n\n /**\n * The type of the automatic discount\n */\n type: 'automatic';\n}" - }, - "CartCustomDiscountAllocation": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartCustomDiscountAllocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountedAmount", - "value": "Money", - "description": "The money amount that has been discounted from the order" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the custom discount" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'custom'", - "description": "The type of the custom discount" - } - ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount\n */\n title: string;\n\n /**\n * The type of the custom discount\n */\n type: 'custom';\n}" - }, - "CartDiscountCode": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartDiscountCode", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "string", - "description": "The code for the discount" - } - ], - "value": "export interface CartDiscountCode {\n /**\n * The code for the discount\n */\n code: string;\n}" - }, - "Extension": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Extension", - "description": "The meta information about an extension target.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "apiVersion", - "value": "ApiVersion", - "description": "The API version that was set in the extension config file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "capabilities", - "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "editor", - "value": "Editor", - "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension is not running in an editor.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "rendered", - "value": "SubscribableSignalLike", - "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "scriptUrl", - "value": "string", - "description": "The URL to the script that started the extension target." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'purchase.checkout.block.render'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "3.0.10", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension is not running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that will appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify’s UI your code is being\n * injected. This will be one of the targets you have included in your\n * extension’s configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/latest/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" - }, - "ApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ApiVersion", - "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04'", - "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." - }, - "Capability": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Capability", - "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", - "description": "The capabilities an extension has access to.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe." - }, - "Editor": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Editor", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the checkout editor." - } - ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the checkout editor.\n */\n type: 'checkout';\n}" - }, - "I18n": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18n", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatCurrency", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatDate", - "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", - "description": "Returns a localized date value.\n\nThis function behaves like the standard `Intl.DateTimeFormatOptions()` and uses the buyer's locale by default. Formatting options can be passed in as options." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "formatNumber", - "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", - "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "I18nTranslate", - "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." - } - ], - "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses\n * the buyer's locale by default. Formatting options can be passed in as\n * options.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n *\n * @param options.inExtensionLocale - if true, use the extension's locale\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" - }, - "I18nTranslate": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "members": [], - "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" - }, - "CartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "AttributesCartInstructions", - "description": "Cart instructions related to cart attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "delivery", - "value": "DeliveryCartInstructions", - "description": "Cart instructions related to delivery." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discounts", - "value": "DiscountsCartInstructions", - "description": "Cart instructions related to discounts." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "CartLinesCartInstructions", - "description": "Cart instructions related to cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "MetafieldsCartInstructions", - "description": "Cart instructions related to metafields." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "notes", - "value": "NotesCartInstructions", - "description": "Cart instructions related to notes." - } - ], - "value": "export interface CartInstructions {\n /**\n * Cart instructions related to cart attributes.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Cart instructions related to delivery.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Cart instructions related to discounts.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Cart instructions related to cart lines.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Cart instructions related to metafields.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Cart instructions related to notes.\n */\n notes: NotesCartInstructions;\n}" - }, - "AttributesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "AttributesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateAttributes", - "value": "boolean", - "description": "Indicates whether or not cart attributes can be updated." - } - ], - "value": "export interface AttributesCartInstructions {\n /**\n * Indicates whether or not cart attributes can be updated.\n */\n canUpdateAttributes: boolean;\n}" - }, - "DeliveryCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DeliveryCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSelectCustomAddress", - "value": "boolean", - "description": "Indicates whether a buyer can select a custom address.\n\nWhen true, this implies extensions can update the delivery address." - } - ], - "value": "export interface DeliveryCartInstructions {\n /**\n * Indicates whether a buyer can select a custom address.\n *\n * When true, this implies extensions can update the delivery address.\n */\n canSelectCustomAddress: boolean;\n}" - }, - "DiscountsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "DiscountsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateDiscountCodes", - "value": "boolean", - "description": "Indicates whether or not discount codes can be updated." - } - ], - "value": "export interface DiscountsCartInstructions {\n /**\n * Indicates whether or not discount codes can be updated.\n */\n canUpdateDiscountCodes: boolean;\n}" - }, - "CartLinesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLinesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canAddCartLine", - "value": "boolean", - "description": "Indicates whether or not new cart lines can be added." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canRemoveCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be removed." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateCartLine", - "value": "boolean", - "description": "Indicates whether or not cart lines can be updated." - } - ], - "value": "export interface CartLinesCartInstructions {\n /**\n * Indicates whether or not new cart lines can be added.\n */\n canAddCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be removed.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Indicates whether or not cart lines can be updated.\n */\n canUpdateCartLine: boolean;\n}" - }, - "MetafieldsCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "MetafieldsCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canDeleteCartMetafield", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be deleted." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canSetCartMetafields", - "value": "boolean", - "description": "Indicates whether or not cart metafields can be added or updated." - } - ], - "value": "export interface MetafieldsCartInstructions {\n /**\n * Indicates whether or not cart metafields can be added or updated.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Indicates whether or not cart metafields can be deleted.\n */\n canDeleteCartMetafield: boolean;\n}" - }, - "NotesCartInstructions": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "NotesCartInstructions", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "canUpdateNote", - "value": "boolean", - "description": "Indicates whether or not notes can be updated." - } - ], - "value": "export interface NotesCartInstructions {\n /**\n * Indicates whether or not notes can be updated.\n */\n canUpdateNote: boolean;\n}" - }, - "CartLine": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLine", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "The line item additional custom attributes." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The details about the cost components attributed to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "CartDiscountAllocation[]", - "description": "Discounts applied to the cart line." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "These line item IDs are not stable at the moment, they might change after any operations on the line items. You should always look up for an updated ID before any call to `applyCartLinesChange` because you'll need the ID to create a `CartLineChange` object.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLine/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "lineComponents", - "value": "CartBundleLineComponent[]", - "description": "Sub lines of the merchandise line. If no sub lines are present, this will be an empty array." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parentRelationship", - "value": "CartLineParentRelationship | null", - "description": "The relationship details between cart lines." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of the merchandise being purchased." - } - ], - "value": "export interface CartLine {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The merchandise being purchased.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of the merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The details about the cost components attributed to the cart line.\n */\n cost: CartLineCost;\n\n /**\n * The line item additional custom attributes.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to the cart line.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The relationship details between cart lines.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" - }, - "CartLineCost": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineCost", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "totalAmount", - "value": "Money", - "description": "The total amount after reductions the buyer can expect to pay that is directly attributable to a single cart line." - } - ], - "value": "export interface CartLineCost {\n /**\n * The total amount after reductions the buyer can expect to pay that is directly attributable to a single\n * cart line.\n */\n totalAmount: Money;\n}" - }, - "CartBundleLineComponent": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartBundleLineComponent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "Attribute[]", - "description": "Additional custom attributes for the bundle line component.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "[{key: 'engraving', value: 'hello world'}]", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartLineCost", - "description": "The cost attributed to this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the bundle line component.\n\nThis ID is not stable. If an operation updates the line items in any way, all IDs could change.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/CartLineComponent/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "merchandise", - "value": "Merchandise", - "description": "The merchandise of this bundle line component." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "quantity", - "value": "number", - "description": "The quantity of merchandise being purchased." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'bundle'", - "description": "" - } - ], - "value": "export interface CartBundleLineComponent {\n type: 'bundle';\n\n /**\n * A unique identifier for the bundle line component.\n *\n * This ID is not stable. If an operation updates the line items in any way, all IDs could change.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The merchandise of this bundle line component.\n */\n merchandise: Merchandise;\n\n /**\n * The quantity of merchandise being purchased.\n */\n quantity: number;\n\n /**\n * The cost attributed to this bundle line component.\n */\n cost: CartLineCost;\n\n /**\n * Additional custom attributes for the bundle line component.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" - }, - "Merchandise": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Merchandise", - "value": "ProductVariant", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/ProductVariant/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "product", - "value": "Product", - "description": "The product object that the product variant belongs to." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "requiresShipping", - "value": "boolean", - "description": "Whether or not the product requires shipping." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "selectedOptions", - "value": "SelectedOption[]", - "description": "List of product options applied to the variant." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sellingPlan", - "value": "SellingPlan", - "description": "The selling plan associated with the merchandise.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "sku", - "value": "string", - "description": "The product variant's sku.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "The product variant's subtitle.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The product variant’s title." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'variant'", - "description": "" - } - ] - }, - "Product": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Product", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "productType", - "value": "string", - "description": "A categorization that a product can be tagged with, commonly used for filtering and searching." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "vendor", - "value": "string", - "description": "The product’s vendor name." - } - ], - "value": "export interface Product {\n /**\n * A globally-unique identifier.\n */\n id: string;\n\n /**\n * The product’s vendor name.\n */\n vendor: string;\n\n /**\n * A categorization that a product can be tagged with, commonly used for filtering and searching.\n */\n productType: string;\n}" - }, - "SelectedOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SelectedOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the merchandise option." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value of the merchandise option." - } - ], - "value": "export interface SelectedOption {\n /**\n * The name of the merchandise option.\n */\n name: string;\n\n /**\n * The value of the merchandise option.\n */\n value: string;\n}" - }, - "SellingPlan": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "SellingPlan", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/SellingPlan/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "recurringDeliveries", - "value": "boolean", - "description": "Whether purchasing the selling plan will result in multiple deliveries." - } - ], - "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier.\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing the selling plan will result in multiple deliveries.\n */\n recurringDeliveries: boolean;\n}" - }, - "CartLineParentRelationship": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "CartLineParentRelationship", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "parent", - "value": "{ id: string; }", - "description": "The parent cart line that a cart line is associated with." - } - ], - "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs are not stable at the moment, they might change after\n * any operations on the line items. You should always look up for an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" - }, - "Localization": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Localization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the country is unknown, then the value is undefined." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency that the customer sees for money amounts in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "This is the customer's language, as supported by the extension. If the customer's actual language is not supported by the extension, then this is the language that is used for translations.\n\nFor example, if the customer's language is 'fr-CA' but your extension only supports translations for 'fr', then the `isoCode` for this language is 'fr'. If your extension does not provide french translations at all, then this value is the default locale for your extension (that is, the one matching your .default.json file)." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the customer sees in the checkout." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/markets) context of the checkout. This value carries over from the context of the cart, where it was used to contextualize the storefront experience. It will update if the buyer changes the country of their shipping address. If the market is unknown, then the value is undefined.\n\n> Caution: This field is deprecated and will be removed in a future version.", - "deprecationMessage": "Deprecated as of version `2025-04`" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer’s time zone." - } - ], - "value": "export interface Localization {\n /**\n * The currency that the customer sees for money amounts in the checkout.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer’s time zone.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the customer sees in the checkout.\n */\n language: SubscribableSignalLike;\n\n /**\n * This is the customer's language, as supported by the extension.\n * If the customer's actual language is not supported by the extension,\n * then this is the language that is used for translations.\n *\n * For example, if the customer's language is 'fr-CA' but your extension\n * only supports translations for 'fr', then the `isoCode` for this\n * language is 'fr'. If your extension does not provide french\n * translations at all, then this value is the default locale for your\n * extension (that is, the one matching your .default.json file).\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout. This value carries over from the\n * context of the cart, where it was used to contextualize the storefront\n * experience. It will update if the buyer changes the country of their\n * shipping address. If the country is unknown, then the value is undefined.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/markets) context of the\n * checkout. This value carries over from the context of the cart, where it\n * was used to contextualize the storefront experience. It will update if the\n * buyer changes the country of their shipping address. If the market is unknown,\n * then the value is undefined.\n *\n * > Caution: This field is deprecated and will be removed in a future version.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" - }, - "Country": { - "filePath": "src/shared.ts", - "name": "Country", - "description": "", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CountryCode", - "description": "The ISO-3166-1 code for this country." - } - ], - "value": "export interface Country {\n /**\n * The ISO-3166-1 code for this country.\n * @see https://www.iso.org/iso-3166-country-codes.html\n */\n isoCode: CountryCode;\n}" - }, - "Currency": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Currency", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "CurrencyCode", - "description": "The ISO-4217 code for this currency." - } - ], - "value": "export interface Currency {\n /**\n * The ISO-4217 code for this currency.\n * @see https://www.iso.org/iso-4217-currency-codes.html\n */\n isoCode: CurrencyCode;\n}" - }, - "Language": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Language", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "isoCode", - "value": "string", - "description": "The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'en' for English, or 'en-US' for English local to United States.", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Language {\n /**\n * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code.\n *\n * @example 'en' for English, or 'en-US' for English local to United States.\n * @see https://en.wikipedia.org/wiki/IETF_language_tag\n * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\n */\n isoCode: string;\n}" - }, - "Market": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Market", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The human-readable, shop-scoped identifier for the market." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for a market." - } - ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for a market.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market.\n */\n handle: string;\n}" - }, - "Timezone": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Timezone", - "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", - "description": "" - }, - "LocalizedField": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "LocalizedField", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "LocalizedFieldKey", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - } - ], - "value": "export interface LocalizedField {\n key: LocalizedFieldKey;\n title: string;\n value: string;\n}" - }, - "LocalizedFieldKey": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "LocalizedFieldKey", - "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", - "description": "A union of keys for the localized fields that are required by certain countries." - }, - "StorefrontApiVersion": { - "filePath": "src/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "StorefrontApiVersion", - "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10'", - "description": "Union of supported storefront API versions" - }, - "GraphQLError": { - "filePath": "src/shared.ts", - "name": "GraphQLError", - "description": "GraphQL error returned by the Shopify Storefront APIs.", - "members": [ - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "extensions", - "value": "{ requestId: string; code: string; }", - "description": "" - }, - { - "filePath": "src/shared.ts", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "" - } - ], - "value": "export interface GraphQLError {\n message: string;\n extensions: {\n requestId: string;\n code: string;\n };\n}" - }, - "SelectedPaymentOption": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SelectedPaymentOption", - "value": "PaymentOption", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "handle", - "value": "string", - "description": "The unique handle for the payment option.\n\nThis is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", - "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are only available to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment that will be collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. |\n| `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |" - } - ] - }, - "SessionToken": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "SessionToken", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "get", - "value": "() => Promise", - "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself." - } - ], - "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method will return cached tokens when possible, so you don’t need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" - }, - "ExtensionSettings": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ExtensionSettings", - "value": "Record<\n string,\n string | number | boolean | undefined\n>", - "description": "The merchant-defined setting values for the extension.", - "members": [] - }, - "ShippingAddress": { - "filePath": "src/surfaces/checkout/api/shared.ts", - "name": "ShippingAddress", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address1", - "value": "string", - "description": "The first line of the buyer's address, including street name and number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'151 O'Connor Street'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "address2", - "value": "string", - "description": "The second line of the buyer's address, like apartment number, suite, etc.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ground floor'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "city", - "value": "string", - "description": "The buyer's city.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Ottawa'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "string", - "description": "The buyer's company name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Shopify'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "countryCode", - "value": "CountryCode", - "description": "The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'CA' for Canada.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The buyer's first name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The buyer's last name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The buyer's full name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'John Doe'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "oneTimeUse", - "value": "boolean", - "description": "Specifies whether the address should be saved to the buyer's account.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The buyer's phone number.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'+1 613 111 2222'.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "provinceCode", - "value": "string", - "description": "The buyer's province code, such as state, province, prefecture, or region.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'ON' for Ontario.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "zip", - "value": "string", - "description": "The buyer's postal or ZIP code.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "isOptional": true, - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'K2P 2L8'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Specifies whether the address should be saved to the buyer's account.\n */\n oneTimeUse?: boolean;\n}" - }, - "Shop": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Shop", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "The shop ID.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Shop/123'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "myshopifyDomain", - "value": "string", - "description": "The shop's myshopify.com domain." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The name of the shop." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "storefrontUrl", - "value": "string", - "description": "The primary storefront URL.\n\n> Caution: > As of version `2024-04` this value will no longer have a trailing slash.", - "isOptional": true - } - ], - "value": "export interface Shop {\n /**\n * The shop ID.\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The name of the shop.\n */\n name: string;\n /**\n * The primary storefront URL.\n *\n * > Caution:\n * > As of version `2024-04` this value will no longer have a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's myshopify.com domain.\n */\n myshopifyDomain: string;\n}" - }, - "Storage": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is only available to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "delete", - "value": "(key: string) => Promise", - "description": "Delete stored data by key." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "read", - "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." - }, - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "write", - "value": "(key: string, data: any) => Promise", - "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." - } - ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" - }, - "Ui": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Ui", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "PropertySignature", - "name": "overlay", - "value": "Overlay", - "description": "Allows the extension to close an overlay programmatically.\n\nSupported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover)." - } - ], - "value": "export interface Ui {\n /**\n * Allows the extension to close an overlay programmatically.\n *\n * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).\n */\n overlay: Overlay;\n}" - }, - "Overlay": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "name": "Overlay", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "MethodSignature", - "name": "close", - "value": "(overlayId: string) => void", - "description": "Closes the overlay with the given ID." - } - ], - "value": "interface Overlay {\n /**\n * Closes the overlay with the given ID.\n */\n close(overlayId: string): void;\n}" - }, - "Version": { - "filePath": "src/surfaces/checkout/api/standard/standard.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "Version", - "value": "string", - "description": "" - } - } - } - ], - "category": "Targets", - "isVisualComponent": false, - "requires": "access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.", - "type": "Target" - }, - { - "name": "Abbreviation", - "description": "Displays abbreviated text or acronyms, revealing their full meaning or additional context through a tooltip on hover or focus. Use to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "abbreviation-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "AbbreviationElementProps", - "typeDefinitions": { - "AbbreviationElementProps": { - "filePath": "src/surfaces/checkout/components/Abbreviation.ts", - "name": "AbbreviationElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Abbreviation.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Abbreviation.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", - "isOptional": true, - "defaultValue": "''" - } - ], - "value": "export interface AbbreviationElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "abbreviation-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-abbreviation title=\"United States Dollar\">USD</s-abbreviation>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Announcement", - "description": "The Announcement component provides a less disruptive alternative to auto-open modals for capturing user attention. It provides a standardized way to engage users without being too intrusive.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "announcement-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Feedback and status indicators", - "definitions": [ - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "AnnouncementElementEvents", - "typeDefinitions": { - "AnnouncementElementEvents": { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "name": "AnnouncementElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "PropertySignature", - "name": "aftertoggle", - "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "PropertySignature", - "name": "dismiss", - "value": "CallbackEventListener", - "description": "Callback fired when the announcement is dismissed by the user (either via the built-in dismiss button or programmatically).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "PropertySignature", - "name": "toggle", - "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", - "isOptional": true - } - ], - "value": "export interface AnnouncementElementEvents {\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n /**\n * Callback fired when the announcement is dismissed by the user\n * (either via the built-in dismiss button or programmatically).\n */\n dismiss?: CallbackEventListener;\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - }, - "ToggleArgumentsEvent": { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "name": "ToggleArgumentsEvent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "PropertySignature", - "name": "newState", - "value": "ToggleState", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "PropertySignature", - "name": "oldState", - "value": "ToggleState", - "description": "", - "isOptional": true - } - ], - "value": "export interface ToggleArgumentsEvent {\n oldState?: ToggleState;\n newState?: ToggleState;\n}" - }, - "ToggleState": { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ToggleState", - "value": "'open' | 'closed'", - "description": "" - } - } - }, - { - "title": "Methods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", - "type": "AnnouncementElementMethods", - "typeDefinitions": { - "AnnouncementElementMethods": { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "name": "AnnouncementElementMethods", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Announcement.ts", - "syntaxKind": "PropertySignature", - "name": "dismiss", - "value": "() => void", - "description": "" - } - ], - "value": "export interface AnnouncementElementMethods {\n dismiss: AnnouncementMethods['dismiss'];\n}" - } - } - } - ], - "defaultExample": { - "image": "announcement-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-announcement>\n <s-stack direction=\"inline\" gap=\"base\">\n <s-text>Check our latest offers</s-text>\n <s-link commandFor=\"modal\" command=\"--show\"> Fill out the survey </s-link>\n </s-stack>\n <s-modal id=\"modal\" heading=\"Tell us about your shopping experience\">\n <s-stack gap=\"base\">\n <s-text>We'd love to hear about your shopping experience</s-text>\n <s-text-area\n rows=\"4\"\n label=\"How can we make your shopping experience better?\"\n ></s-text-area>\n <s-button>Submit</s-button>\n </s-stack>\n </s-modal>\n</s-announcement>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "- Prioritize the default state: The most effective use of the announcement bar is when content is short enough to display entirely in its default state, with no need for expansion. This provides the best user experience.\n- Handle content truncation: The component has a strict maximum height. Content that exceeds the expanded state’s height will be cut off with no scrolling capability. Ensure your application’s logic handles excessively long content gracefully to prevent truncation.\n- Provide a modal alternative: If your application needs to display more than a few lines of content, avoid cramming it into the announcement bar. Instead, use the bar as a teaser that links to a modal. This is the recommended pattern for displaying surveys, detailed offers, or other longer-form content." - } - ] - }, - { - "name": "Badge", - "description": "The badge component displays status information or indicates completed actions through compact visual indicators. Use badge to communicate object states, order statuses, or system-generated classifications that help users quickly understand item conditions.\n\nBadges support multiple tones and sizes, with optional icons to reinforce status meaning and improve scannability in lists and tables. For user-created labels, categories, or tags, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip) instead.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "badge-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Feedback and status indicators", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "BadgeElementProps", - "typeDefinitions": { - "BadgeElementProps": { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "name": "BadgeElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "iconPosition", - "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'small' | 'base' | 'small-100'", - "description": "Adjusts the size.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface BadgeElementProps extends Pick {\n size?: Extract;\n tone?: Extract;\n color?: Extract;\n icon?: '' | ReducedIconTypes;\n}" - }, - "ReducedIconTypes": { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedIconTypes", - "value": "'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "badge-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-badge>Default</s-badge>\n<s-badge tone=\"critical\">Expired</s-badge>\n<s-badge color=\"subdued\">Free</s-badge>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Banner", - "description": "The banner component highlights important information or required actions prominently within the interface. Use banner to communicate statuses, provide feedback, draw attention to critical updates, or guide users toward necessary actions.\n\nBanners support multiple tones to convey urgency levels, optional actions for next steps, and can be positioned contextually within sections or page-wide at the top. For inline status indicators on individual items, use [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "banner-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Feedback and status indicators", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "BannerElementProps", - "typeDefinitions": { - "BannerElementProps": { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "name": "BannerElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "collapsible", - "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "dismissible", - "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "heading", - "value": "string", - "description": "The title of the banner.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface BannerElementProps extends Pick {\n tone?: Extract;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "BannerElementEvents", - "typeDefinitions": { - "BannerElementEvents": { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "name": "BannerElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "afterhide", - "value": "CallbackEventListener", - "description": "Event handler when the banner has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "PropertySignature", - "name": "dismiss", - "value": "CallbackEventListener", - "description": "Event handler when the banner is dismissed by the user.\n\nThis does not fire when setting `hidden` manually.\n\nThe `hidden` property will be `false` when this event fires.", - "isOptional": true - } - ], - "value": "export interface BannerElementEvents {\n /**\n * Event handler when the banner has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n *\n * @implementation If implementations animate the hiding of the banner,\n * this event must fire after the banner has fully hidden.\n * We can add an `onHide` event in future if we want to provide a hook for the start of the animation.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the banner is dismissed by the user.\n *\n * This does not fire when setting `hidden` manually.\n *\n * The `hidden` property will be `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Banner.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "banner-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-banner heading=\"Free shipping on all orders.\" tone=\"info\"></s-banner>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "- Use banners thoughtfully and sparingly, and only for the most important information. Too many banners distract customers from completing checkout.\n\n- Banners are typically displayed at the top of a page or a section, if they relate to specific content. Place banners below the relevant page or section header.\n\n- Include a Button component with next steps when possible.\n\n- Make banners dismissible, unless they contain critical information or an important step that customers need to take.\n\n- Use the `info` banner to update customers about a change or to give them advice.\n\n- Use the `warning` banner to display information that needs attention or that customers need to take action on. Warning banners can be stressful for customers, so be cautious about using them.\n\n- Use the `critical` banner to communicate problems that customers need to resolve immediately to complete checkout." - } - ] - }, - { - "name": "Box", - "description": "The box component provides a generic, flexible container for custom designs and layouts. Use box to apply styling like backgrounds, padding, borders, or border radius when existing components don't meet your needs, or to nest and group other components.\n\nBox contents maintain their natural size, making it especially useful within layout components that would otherwise stretch their children. For structured layouts, use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack) or [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "box-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "BoxElementProps", - "typeDefinitions": { - "BoxElementProps": { - "filePath": "src/surfaces/checkout/components/Box.ts", - "name": "BoxElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface BoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" - }, - "AccessibilityRole": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AccessibilityRole", - "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "BoxProps": { - "filePath": "src/surfaces/checkout/components/Box.ts", - "name": "BoxProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Box.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface BoxProps extends BoxElementProps {\n}" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - }, - "PaddingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaddingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - }, - "SizeKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeKeyword", - "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", - "description": "" - }, - "MaybeTwoValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeTwoValuesShorthandProperty", - "value": "T | `${T} ${T}`", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "box-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-box\n background=\"subdued\"\n borderRadius=\"base\"\n borderWidth=\"base\"\n padding=\"base\"\n>\n <s-paragraph>\n Baked fresh to order. Please order 1-2 days before needed due to potential\n shipping variations.\n </s-paragraph>\n</s-box>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use `s-box` when you need a container that preserves the natural size of its contents.\n- `s-box` is particularly useful in layout components like `s-stack` where you want to prevent children from stretching to fit.\n- `s-box` has a `display: block` layout by default.\n- Use `s-box` for simple container needs where you don't need the additional features of more specialized components like `s-stack`.\n- Consider using `s-box` when you need to apply specific styling or layout properties to a group of elements without affecting their natural dimensions." - } - ] - }, - { - "name": "Button", - "description": "The button component triggers actions or events, such as submitting forms, opening dialogs, or navigating to other pages. Use buttons to let users perform specific tasks or initiate interactions throughout the interface.\n\nButtons support various visual styles, tones, and interaction patterns to communicate intent and hierarchy. They can also function as links, guiding users to internal or external destinations. For navigation-focused interactions within text, use [link](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/link). For grouping multiple related buttons, use [button group](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button-group).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "button-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Actions", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ButtonElementProps", - "typeDefinitions": { - "ButtonElementProps": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the Button text is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the Button meaning it cannot be clicked or receive focus.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The displayed inline width of the Button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator while a background action is being performed.\n\nThis also disables the Button.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'primary' | 'secondary'", - "description": "Changes the visual appearance of the Button.", - "isOptional": true, - "defaultValue": "'auto' - the variant is automatically determined by the Button's context" - } - ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ButtonElementEvents", - "typeDefinitions": { - "ButtonElementEvents": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true - } - ], - "value": "export interface ButtonElementEvents {\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "button-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-button variant=\"secondary\">Cancel</s-button>\n<s-button variant=\"primary\">Save</s-button>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "**Content Best Practices**\n\n- Clearly label each button to accurately represent the action associated with it.\n\n- Use strong actionable verbs at the beginning of button text to make it clear to the user what action will occur when the button is clicked.\n\n**Hierarchy Best Practices**\n\n- Establish a visual hierarchy between buttons to minimize confusion and help users understand which actions are most important.\n\n- Use only one high-emphasis button (primary button) per context to make it clear that other buttons have less importance.\n\n- Use lower-emphasis buttons for secondary calls to action.\n\n- Use primary buttons for actions that progress users through checkout such as “Pay now” or for concluding an action in a modal such as “Apply”.\n\n- Use secondary buttons to provide alternative actions to the primary button, without disrupting the primary flow such as “Track your order”.\n\n**When to Use Buttons**\n\n- Use buttons to communicate actions the user can take.\n\n- Use buttons to allow users to interact with the page.\n\n**When Not to Use Buttons**\n\n- Don’t use buttons as navigational elements. Use links instead when the desired action is to take the user to a new page." - } - ] - }, - { - "name": "Checkbox", - "description": "The checkbox component provides a clear way for users to make selections, such as agreeing to terms, enabling settings, or choosing multiple items from a list. Use checkbox to create binary on/off controls or multi-select interfaces where users can select any combination of options.\n\nCheckboxes support labels, help text, error states, and an indeterminate state for \"select all\" functionality when working with grouped selections. For settings that take effect immediately, use [switch](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/switch) instead.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "checkbox-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "CheckboxElementProps", - "typeDefinitions": { - "CheckboxElementProps": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "CheckboxElementEvents", - "typeDefinitions": { - "CheckboxElementEvents": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface CheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "checkbox-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-checkbox defaultChecked label=\"Email me with news and offers\"></s-checkbox>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Chip", - "description": "The chip component displays static labels, categories, or attributes that help classify and organize content. Use chip to show product tags, categories, or metadata near the items they describe, helping users identify items with similar properties.\n\nChips support multiple visual variants for different levels of emphasis and can include icons to provide additional visual context. For system-generated status indicators, use [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge). For interactive or removable chips, use [clickable chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/clickable-chip).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "chip-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ChipElementProps", - "typeDefinitions": { - "ChipElementProps": { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "name": "ChipElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface ChipElementProps extends Pick {\n}" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "ChipElementSlots", - "typeDefinitions": { - "ChipElementSlots": { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "name": "ChipElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "graphic", - "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", - "isOptional": true - } - ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "chip-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-chip>50% OFF</s-chip>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Choice list", - "description": "The choice list component presents multiple options for single or multiple selections. Use it when merchants need to choose from a defined set of options, such as filtering results or collecting preferences.\n\nThe component supports both single selection (radio button behavior) and multiple selection (checkbox behavior) modes. It includes configurable labels, help text, and validation. For compact dropdown selection with four or more options, use [select](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/select).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "choice-list-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ChoiceListElementProps", - "typeDefinitions": { - "ChoiceListElementProps": { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "name": "ChoiceListElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "multiple", - "value": "boolean", - "description": "Whether multiple choices can be selected.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "values", - "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface ChoiceListElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ChoiceListElementEvents", - "typeDefinitions": { - "ChoiceListElementEvents": { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "name": "ChoiceListElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface ChoiceListElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/ChoiceList.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Choice", - "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", - "type": "ChoiceElementProps", - "typeDefinitions": { - "ChoiceElementProps": { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "name": "ChoiceElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "defaultSelected", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface ChoiceElementProps extends Pick {\n}" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "ChoiceElementSlots", - "typeDefinitions": { - "ChoiceElementSlots": { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "name": "ChoiceElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "HTMLElement", - "description": "Additional text to provide context or guidance for the input.\n\nThis text is displayed along with the input and its label to offer more information or instructions to the user.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "secondaryContent", - "value": "HTMLElement", - "description": "Secondary content for a choice.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Choice.ts", - "syntaxKind": "PropertySignature", - "name": "selectedContent", - "value": "HTMLElement", - "description": "Content to display when the option is selected.\n\nThis can be used to provide additional information or options related to the choice.", - "isOptional": true - } - ], - "value": "export interface ChoiceElementSlots {\n /**\n * Additional text to provide context or guidance for the input.\n *\n * This text is displayed along with the input and its label\n * to offer more information or instructions to the user.\n *\n * @implementation this content should be linked to the input with an `aria-describedby` attribute.\n */\n details?: HTMLElement;\n /**\n * Secondary content for a choice.\n */\n secondaryContent?: HTMLElement;\n /**\n * Content to display when the option is selected.\n *\n * This can be used to provide additional information or options related to the choice.\n */\n selectedContent?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "choice-list-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-choice-list>\n <s-choice defaultSelected value=\"location-1\"\n >Yonge-Dundas Square locations</s-choice\n >\n <s-choice value=\"location-2\">Distillery District location</s-choice>\n <s-choice value=\"location-3\">Yorkville location</s-choice>\n</s-choice-list>\n", - "language": "html" - } - ] - } - }, - "examples": { - "description": "The `ChoiceList` component offers different variants to suit various use cases. Choose the right variant based on the number of choices, the complexity of the content, and the available screen space. Below are some best practices for each variant.", - "examples": [ - { - "description": "This classic and flexible variant is ideal for up to 10 choices. It’s the most common and recognizable format for making a selection from a vertical list.\n\nBest Practices\n
    \n
  • Keep it simple: Keep the initial content for each item as concise as possible so users can quickly scan and compare their choices.
    • \n
  • Add extra content strategically: Only use the \"selected content\" slot if the information is essential and directly tied to the selected item. For example, a map that shows the location of a chosen address is an effective use case. If the content doesn’t need to be in close proximity to the selected item, place it elsewhere on the page to reduce visual clutter.
    • \n
", - "codeblock": { - "title": "List Variant", - "tabs": [ - { - "code": "<s-choice-list>\n <s-choice defaultSelected value=\"location-1\">Yonge-Dundas Square</s-choice>\n <s-choice value=\"location-2\">Distillery District</s-choice>\n <s-choice value=\"location-3\">Yorkville</s-choice>\n</s-choice-list>\n", - "language": "html" - } - ] - }, - "image": "choicelist-list-variant.png" - }, - { - "description": "This variant is designed for options that require both secondary content and a clear visual separation. It’s well-suited for up to 5 choices where each item is complex and needs its own defined space. Due to its \"chunky\" footprint, using more than 5 can take up too much vertical space.\n\nBest Practices\n
    \n
  • Focus on clarity: Use this variant to help users compare options with more complexity than a simple list, such as an item with a title, a description, and a price.
    • \n
  • Be intentional with extra content: Just like the List variant, only include extra content when it’s crucial for the user to make a final decision and when its close proximity to the selected block is a benefit.
    • \n
", - "codeblock": { - "title": "Block Variant", - "tabs": [ - { - "code": "<s-choice-list variant=\"block\">\n <s-choice defaultSelected value=\"yonge-dundas\">\n <s-stack\n direction=\"inline\"\n justifyContent=\"space-between\"\n alignItems=\"start\"\n >\n <s-stack gap=\"none\">\n <s-text>Yonge-Dundas Square</s-text>\n <s-text slot=\"secondary-content\" type=\"small\" color=\"subdued\"\n >1 Dundas St E, Toronto ON</s-text\n >\n </s-stack>\n <s-text color=\"subdued\">1.2 km</s-text>\n </s-stack>\n </s-choice>\n <s-choice value=\"distillery\">\n <s-stack\n direction=\"inline\"\n justifyContent=\"space-between\"\n alignItems=\"start\"\n >\n <s-stack gap=\"none\">\n <s-text>Distillery District</s-text>\n <s-text slot=\"secondary-content\" type=\"small\" color=\"subdued\"\n >55 Mill St, Toronto ON</s-text\n >\n </s-stack>\n <s-text color=\"subdued\">4 km</s-text>\n </s-stack>\n </s-choice>\n <s-choice value=\"yorkville\">\n <s-stack\n direction=\"inline\"\n justifyContent=\"space-between\"\n alignItems=\"start\"\n >\n <s-stack gap=\"none\">\n <s-text>Yorkville</s-text>\n <s-text slot=\"secondary-content\" type=\"small\" color=\"subdued\"\n >55 Avenue Rd, Toronto ON</s-text\n >\n </s-stack>\n <s-text color=\"subdued\">6 km</s-text>\n </s-stack>\n </s-choice>\n</s-choice-list>\n", - "language": "html" - } - ] - }, - "image": "choicelist-block-variant.png" - }, - { - "description": "This compact variant is ideal when screen real estate is limited. It works best for up to 3 to 5 choices depending on the typical length of the content.\n\nBest Practices\n
    \n
  • Keep content short and simple: Due to its horizontal layout, content for each item must be succinct, simple, and short, especially on mobile.
    • \n
  • Avoid extra content: This variant does not support extra content upon selection, so it’s best for a scenario where the user's decision doesn’t require additional information.
    • \n
", - "codeblock": { - "title": "Inline Variant", - "tabs": [ - { - "code": "<s-choice-list variant=\"inline\">\n <s-choice defaultSelected value=\"3.50\">$3.50</s-choice>\n <s-choice value=\"4.50\">$4.50</s-choice>\n <s-choice value=\"5.50\">$5.50</s-choice>\n <s-choice value=\"other\">Other</s-choice>\n</s-choice-list>\n", - "language": "html" - } - ] - }, - "image": "choicelist-inline-variant.png" - }, - { - "description": "This variant is best for up to 6 choices, arranged in a grid-like layout. It’s great for scenarios where choices have significant visual differences and need to be arranged for easy comparison.\n\nBest Practices\n
    \n
  • Keep content short and simple: The content in each item needs to be succinct and simple because the horizontal and vertical constraints of the grid can limit the available space.
    • \n
  • Avoid extra content: This variant does not support extra content upon selection, so it’s best for a scenario where the user's decision doesn’t require additional information.
    • \n
", - "codeblock": { - "title": "Grid Variant", - "tabs": [ - { - "code": "<s-choice-list variant=\"grid\">\n <s-choice defaultSelected value=\"standard\">Standard</s-choice>\n <s-choice value=\"deluxe\">Deluxe</s-choice>\n <s-choice value=\"personalized\">Personalized</s-choice>\n</s-choice-list>\n", - "language": "html" - } - ] - }, - "image": "choicelist-grid-variant.png" - } - ] - }, - "subSections": [] - }, - { - "name": "Clickable", - "description": "The clickable component wraps content to make it interactive and clickable. Use it when you need more styling control than [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) or [link](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/link) provide, such as custom backgrounds, padding, or borders around your clickable content.\n\nClickable supports button, link, and submit modes with built-in accessibility properties for keyboard navigation and screen reader support.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "clickable-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Actions", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ClickableElementProps", - "typeDefinitions": { - "ClickableElementProps": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "name": "ClickableElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, onClick will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress.\n\nThis also disables the clickable.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - } - ], - "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n type?: Extract;\n}" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "ClickableProps": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "name": "ClickableProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, onClick will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress.\n\nThis also disables the clickable.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "onBlur", - "value": "(event: FocusEvent) => void", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "Callback when the Button is activated. This will be called before the action indicated by `type`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "onFocus", - "value": "(event: FocusEvent) => void", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - } - ], - "value": "export interface ClickableProps extends ClickableElementProps, ClickableEvents {\n}" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - }, - "PaddingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaddingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - }, - "SizeKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeKeyword", - "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", - "description": "" - }, - "MaybeTwoValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeTwoValuesShorthandProperty", - "value": "T | `${T} ${T}`", - "description": "" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ClickableElementEvents", - "typeDefinitions": { - "ClickableElementEvents": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "name": "ClickableElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - } - ], - "value": "export interface ClickableElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Clickable.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "clickable-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-clickable>\n <s-product-thumbnail src=\"https://cdn.shopify.com/YOUR_IMAGE_HERE\"></s-product-thumbnail>\n</s-clickable>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Clickable chip", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "clickable-chip-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Actions", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ClickableChipElementProps", - "typeDefinitions": { - "ClickableChipElementProps": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "removable", - "value": "boolean", - "description": "Whether the chip is removable.", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface ClickableChipElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ClickableChipElementEvents", - "typeDefinitions": { - "ClickableChipElementEvents": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "afterhide", - "value": "CallbackEventListener", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Event handler when the chip is clicked.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "remove", - "value": "CallbackEventListener", - "description": "Event handler when the chip is removed.", - "isOptional": true - } - ], - "value": "export interface ClickableChipElementEvents {\n /**\n * Event handler when the chip has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the chip is clicked.\n */\n click?: CallbackEventListener;\n /**\n * Event handler when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "ClickableChipElementSlots", - "typeDefinitions": { - "ClickableChipElementSlots": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "graphic", - "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", - "isOptional": true - } - ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "clickable-chip-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-clickable-chip removable>Shipping insurance</s-clickable-chip>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Clipboard item", - "description": "Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `` doesn’t render visually.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": false, - "thumbnail": "clipboard-item-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "utilities", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ClipboardItemElementProps", - "typeDefinitions": { - "ClipboardItemElementProps": { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "name": "ClipboardItemElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "syntaxKind": "PropertySignature", - "name": "text", - "value": "string", - "description": "Plain text to be written to the clipboard.", - "isOptional": true, - "defaultValue": "''" - } - ], - "value": "export interface ClipboardItemElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ClipboardItemElementEvents", - "typeDefinitions": { - "ClipboardItemElementEvents": { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "name": "ClipboardItemElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "syntaxKind": "PropertySignature", - "name": "copy", - "value": "CallbackEventListener", - "description": "Callback run when the copy to clipboard succeeds.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "syntaxKind": "PropertySignature", - "name": "copyerror", - "value": "CallbackEventListener", - "description": "Callback run when the copy to clipboard fails.", - "isOptional": true - } - ], - "value": "export interface ClipboardItemElementEvents {\n /**\n * Callback run when the copy to clipboard succeeds.\n */\n copy?: CallbackEventListener;\n /**\n * Callback run when the copy to clipboard fails.\n */\n copyerror?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "clipboard-item-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-button commandFor=\"discount-code\">Copy discount code</s-button>\n<s-clipboard-item id=\"discount-code\" text=\"SAVE 25\"></s-clipboard-item>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Consent checkbox", - "description": "Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "consent-checkbox-thumbnail.png", - "requires": "enabling of the `sms_marketing` capability of the [Customer Privacy](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability group to work.", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ConsentCheckboxElementProps", - "typeDefinitions": { - "ConsentCheckboxElementProps": { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "name": "ConsentCheckboxElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n}" - }, - "ConsentPolicy": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ConsentCheckboxElementEvents", - "typeDefinitions": { - "ConsentCheckboxElementEvents": { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "name": "ConsentCheckboxElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "consent-checkbox-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-consent-checkbox\n defaultChecked\n label=\"Text me with news and offers\"\n policy=\"sms-marketing\"\n></s-consent-checkbox>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Consent phone field", - "description": "Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "consent-phone-field-thumbnail.png", - "requires": "enabling of the `sms_marketing` capability of the [Customer Privacy](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability group to work.", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ConsentPhoneFieldElementProps", - "typeDefinitions": { - "ConsentPhoneFieldElementProps": { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "name": "ConsentPhoneFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", - "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - }, - "ConsentPolicy": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ConsentPhoneFieldElementEvents", - "typeDefinitions": { - "ConsentPhoneFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "name": "ConsentPhoneFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "ConsentPhoneFieldElementSlots", - "typeDefinitions": { - "ConsentPhoneFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "name": "ConsentPhoneFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "consent-phone-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-consent-phone-field\n label=\"Phone\"\n policy=\"sms-marketing\"\n defaultValue=\"587-746-7439\"\n></s-consent-phone-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Date field", - "description": "The date field component captures date input with a consistent interface for date selection and proper validation. Use it to collect date information in forms, scheduling interfaces, or data entry workflows.\n\nThe component supports manual text entry. For visual calendar-based selection, consider using [date picker](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-picker).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "date-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "DateFieldElementProps", - "typeDefinitions": { - "DateFieldElementProps": { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "name": "DateFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "allow", - "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "allowDays", - "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultView", - "value": "string", - "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "disallow", - "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "disallowDays", - "value": "string", - "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "view", - "value": "string", - "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", - "isOptional": true - } - ], - "value": "export interface DateFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "DateFieldElementEvents", - "typeDefinitions": { - "DateFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "name": "DateFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "invalid", - "value": "CallbackEventListener", - "description": "Callback when the user enters an invalid date.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "PropertySignature", - "name": "viewChange", - "value": "CallbackEventListener", - "description": "Callback when the view changes.", - "isOptional": true - } - ], - "value": "export interface DateFieldElementEvents {\n /**\n * Callback when the element loses focus.\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user enters an invalid date.\n */\n invalid?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/DateField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "date-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-date-field label=\"Pickup date\" defaultValue=\"2025-10-01\"></s-date-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Date picker", - "description": "The date picker component allows merchants to select dates using a calendar interface. Use it when merchants benefit from seeing dates in context of the full month, such as selecting dates relative to today or needing weekday context.\n\nThe component supports single dates, multiple dates, and date ranges. For text date entry, use [date field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "date-picker-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "DatePickerElementProps", - "typeDefinitions": { - "DatePickerElementProps": { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "name": "DatePickerElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "allow", - "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "allowDays", - "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "Default selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", - "isOptional": true, - "defaultValue": "\"\"" - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "defaultView", - "value": "string", - "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "disallow", - "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "disallowDays", - "value": "string", - "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", - "isOptional": true, - "defaultValue": "\"\"", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'single' | 'multiple' | 'range'", - "description": "The type of selection the date picker allows.\n\n- `single` allows selecting a single date.\n- `multiple` allows selecting multiple non-contiguous dates.\n- `range` allows selecting a single range of dates.", - "isOptional": true, - "defaultValue": "\"single\"" - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", - "isOptional": true, - "defaultValue": "\"\"" - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "view", - "value": "string", - "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", - "isOptional": true - } - ], - "value": "export interface DatePickerElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "DatePickerElementEvents", - "typeDefinitions": { - "DatePickerElementEvents": { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "name": "DatePickerElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "PropertySignature", - "name": "viewChange", - "value": "CallbackEventListener", - "description": "Callback when the view changes.", - "isOptional": true - } - ], - "value": "export interface DatePickerElementEvents {\n /**\n * Callback when the element loses focus.\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/DatePicker.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "date-picker-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-date-picker defaultView=\"2025-10\" defaultValue=\"2025-10-03\"></s-date-picker>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Details", - "description": "Creates a collapsible content area that can be expanded or collapsed by users. Use with Summary to provide expandable sections for additional information or settings.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "details-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Interactive", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "DetailsElementProps", - "typeDefinitions": { - "DetailsElementProps": { - "filePath": "src/surfaces/checkout/components/Details.ts", - "name": "DetailsElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "defaultOpen", - "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "open", - "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "toggleTransition", - "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface DetailsElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "DetailsElementEvents", - "typeDefinitions": { - "DetailsElementEvents": { - "filePath": "src/surfaces/checkout/components/Details.ts", - "name": "DetailsElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "aftertoggle", - "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "toggle", - "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", - "isOptional": true - } - ], - "value": "export interface DetailsElementEvents {\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - }, - "ToggleArgumentsEvent": { - "filePath": "src/surfaces/checkout/components/Details.ts", - "name": "ToggleArgumentsEvent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "newState", - "value": "ToggleState", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "PropertySignature", - "name": "oldState", - "value": "ToggleState", - "description": "", - "isOptional": true - } - ], - "value": "export interface ToggleArgumentsEvent {\n oldState?: ToggleState;\n newState?: ToggleState;\n}" - }, - "ToggleState": { - "filePath": "src/surfaces/checkout/components/Details.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ToggleState", - "value": "'open' | 'closed'", - "description": "" - } - } - }, - { - "title": "Summary", - "description": "Provides a clickable label for collapsible Details content. Use to create clear, accessible disclosure controls that show or hide additional information.", - "type": "SummaryElementProps", - "typeDefinitions": { - "SummaryElementProps": { - "filePath": "src/surfaces/checkout/components/Summary.ts", - "name": "SummaryElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Summary.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface SummaryElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "details-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-details defaultOpen>\n <s-summary>Pickup instructions</s-summary>\n <s-text>\n Curbside pickup is at the back of the warehouse. Park in a stall and follow the signs.\n </s-text>\n</s-details>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Divider", - "description": "The divider component creates clear visual separation between elements in the interface. Use divider to separate distinct content groups in forms, settings panels, lists, or page sections, helping users scan and understand content organization.\n\nDividers support both horizontal and vertical orientations, along with different visual strengths for varying levels of emphasis. For more structured content grouping with headings, use [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "divider-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "DividerElementProps", - "typeDefinitions": { - "DividerElementProps": { - "filePath": "src/surfaces/checkout/components/Divider.ts", - "name": "DividerElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Divider.ts", - "syntaxKind": "PropertySignature", - "name": "direction", - "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", - "isOptional": true, - "defaultValue": "'inline'" - }, - { - "filePath": "src/surfaces/checkout/components/Divider.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface DividerElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "divider-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-divider></s-divider>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Drop zone", - "description": "The drop zone component lets users upload files through drag-and-drop or by clicking to browse. Use for file uploads such as images, documents, or CSV imports.\n\nThe component provides visual feedback during drag operations and supports file type validation through the `accept` property. Rejected files trigger the `droprejected` event for custom error handling.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "drop-zone-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "DropZoneElementProps", - "typeDefinitions": { - "DropZoneElementProps": { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "name": "DropZoneElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "accept", - "value": "string", - "description": "A string representing the types of files that are accepted by the drop zone. This string is a comma-separated list of unique file type specifiers which can be one of the following:\n- A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the item. When set, it will be announced to buyers using assistive technologies and will provide them with more context.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "multiple", - "value": "boolean", - "description": "Whether multiple files can be selected or dropped at once.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file.", - "isOptional": true, - "defaultValue": "''" - } - ], - "value": "export interface DropZoneElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "DropZoneElementEvents", - "typeDefinitions": { - "DropZoneElementEvents": { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "name": "DropZoneElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has finished selecting a file or files.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "droprejected", - "value": "CallbackEventListener", - "description": "Callback when rejected files are dropped. Files are rejected based on the `accept` prop.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface DropZoneElementEvents {\n /**\n * Callback when rejected files are dropped. Files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user has finished selecting a file or files.\n */\n change?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/DropZone.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "drop-zone-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-drop-zone accept=\"image/*\"></s-drop-zone>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n### File storage\n\nFile storage for uploads must be implemented separately. Metafields and the corresponding [Checkout API](/docs/api/checkout-ui-extensions/latest/apis/metafields) or [Customer Accounts API](/docs/api/customer/latest/mutations/metafieldsSet) can be utilized to store references to files alongside the relevant objects.\n\n### Mobile\n\nRemember that the drag and drop feature won’t be effective on mobile devices. Adding a button can offer additional context and guide users through the next steps.\n\n\"An\n\n### Minimum size\n\nTo prevent cut-off text and spacing issues, the minimum size of a Dropzone should be 100px by 100px.\n\n\"An\n " - } - ] - }, - { - "name": "Email field", - "description": "The email field component captures email address input. Use it to collect email information in forms, customer profiles, or contact workflows.\n\nEmail field doesn't perform automatic email validation. Implement your own validation logic, and use the `error` property to display validation results. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "email-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "EmailFieldElementProps", - "typeDefinitions": { - "EmailFieldElementProps": { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "name": "EmailFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface EmailFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "EmailFieldElementEvents", - "typeDefinitions": { - "EmailFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "name": "EmailFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface EmailFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "EmailFieldElementSlots", - "typeDefinitions": { - "EmailFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "name": "EmailFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/EmailField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface EmailFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "email-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-email-field label=\"Email\" defaultValue=\"snowdevil@shopify.com\"></s-email-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Form", - "description": "The form component wraps form controls and enables implicit submission, allowing users to submit from any input by pressing **Enter**. Use form to group related input fields and handle form submission through JavaScript event handlers.\n\nUnlike HTML forms, form doesn't automatically submit data using HTTP—you must register a `submit` event to process form data programmatically. For Shopify Functions configuration forms, use [function settings](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/function-settings).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "form-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "FormElementProps", - "typeDefinitions": { - "FormElementProps": { - "filePath": "src/surfaces/checkout/components/Form.ts", - "name": "FormElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Form.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether the form is able to be submitted.\n\nWhen set to `true`, this will also disable the implicit submit behavior of the form.", - "isOptional": true, - "deprecationMessage": "Prevent default within the onSubmit callback using a local state instead. Deprecated in v1.6.0", - "isPrivate": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Form.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface FormElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "FormElementEvents", - "typeDefinitions": { - "FormElementEvents": { - "filePath": "src/surfaces/checkout/components/Form.ts", - "name": "FormElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Form.ts", - "syntaxKind": "PropertySignature", - "name": "submit", - "value": "CallbackEventListener", - "description": "A callback that is run when the form is submitted.", - "isOptional": true - } - ], - "value": "export interface FormElementEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Form.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Form.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "form-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-form>\n <s-text-field label=\"Email address\" />\n <s-button type=\"submit\" variant=\"primary\">Submit</s-button>\n</s-form>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Wrap around all form input elements.\n- Forms can have only one submit button and it must be at the end of the form." - } - ] - }, - { - "name": "Grid", - "description": "The grid component organizes content in a matrix of rows and columns to create responsive page layouts. Use grid to build complex, multi-column layouts that adapt to different screen sizes and maintain consistent alignment.\n\nGrid follows the CSS grid layout pattern and supports flexible column configurations, gap spacing, and alignment properties for precise layout control. For simpler linear layouts (horizontal or vertical), use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "grid-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "GridElementProps", - "typeDefinitions": { - "GridElementProps": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "name": "GridElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "alignContent", - "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "alignItems", - "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderColor", - "value": "'' | 'base'", - "description": "Set the color of the border.\n\nIf set, it takes precedence over the `border` property's color.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "columnGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "gap", - "value": "MaybeResponsive>", - "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "gridTemplateColumns", - "value": "MaybeResponsive", - "description": "Define columns and specify their size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "gridTemplateRows", - "value": "MaybeResponsive", - "description": "Define rows and specify their size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "justifyContent", - "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "justifyItems", - "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "placeContent", - "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true, - "defaultValue": "'normal normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "placeItems", - "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true, - "defaultValue": "'normal normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "rowGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface GridElementProps extends Pick {\n alignContent?: MaybeResponsive;\n alignItems?: MaybeResponsive;\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n justifyContent?: MaybeResponsive;\n justifyItems?: MaybeResponsive;\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" - }, - "AccessibilityRole": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AccessibilityRole", - "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "ReducedAlignContentKeyword": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedAlignContentKeyword", - "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "" - }, - "ReducedAlignItemsKeyword": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedAlignItemsKeyword", - "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "GridProps": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "name": "GridProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "alignContent", - "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "alignItems", - "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderColor", - "value": "'' | 'base'", - "description": "Set the color of the border.\n\nIf set, it takes precedence over the `border` property's color.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "columnGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "gap", - "value": "MaybeResponsive>", - "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "gridTemplateColumns", - "value": "MaybeResponsive", - "description": "Define columns and specify their size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "gridTemplateRows", - "value": "MaybeResponsive", - "description": "Define rows and specify their size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "justifyContent", - "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "justifyItems", - "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "placeContent", - "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "placeItems", - "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "PropertySignature", - "name": "rowGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface GridProps extends GridElementProps {\n}" - }, - "SpacingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - }, - "SizeKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeKeyword", - "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", - "description": "" - }, - "MaybeTwoValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeTwoValuesShorthandProperty", - "value": "T | `${T} ${T}`", - "description": "" - }, - "ReducedJustifyContentKeyword": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedJustifyContentKeyword", - "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "" - }, - "ReducedJustifyItemsKeyword": { - "filePath": "src/surfaces/checkout/components/Grid.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedJustifyItemsKeyword", - "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - }, - "PaddingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaddingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - } - } - }, - { - "title": "Grid item", - "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", - "type": "GridItemElementProps", - "typeDefinitions": { - "GridItemElementProps": { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "name": "GridItemElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderColor", - "value": "'' | 'base'", - "description": "Set the color of the border.\n\nIf set, it takes precedence over the `border` property's color.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "gridColumn", - "value": "`span ${number}` | \"auto\"", - "description": "Number of columns the item will span across", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "gridRow", - "value": "`span ${number}` | \"auto\"", - "description": "Number of rows the item will span across", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface GridItemElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" - }, - "AccessibilityRole": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AccessibilityRole", - "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "GridItemProps": { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "name": "GridItemProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderColor", - "value": "'' | 'base'", - "description": "Set the color of the border.\n\nIf set, it takes precedence over the `border` property's color.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "gridColumn", - "value": "`span ${number}` | \"auto\"", - "description": "Number of columns the item will span across", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "gridRow", - "value": "`span ${number}` | \"auto\"", - "description": "Number of rows the item will span across", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/GridItem.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface GridItemProps extends GridItemElementProps {\n}" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - }, - "PaddingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaddingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - }, - "SizeKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeKeyword", - "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", - "description": "" - }, - "MaybeTwoValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeTwoValuesShorthandProperty", - "value": "T | `${T} ${T}`", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "grid-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-grid gridTemplateColumns=\"1fr auto\" gap=\"base\">\n <s-grid-item gridColumn=\"span 2\" border=\"base\" borderStyle=\"dashed\">\n Plants for sale\n </s-grid-item>\n <s-grid-item border=\"base\" borderStyle=\"dashed\">\n Pothos\n </s-grid-item>\n <s-grid-item border=\"base\" borderStyle=\"dashed\">\n $25.00\n </s-grid-item>\n</s-grid>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Heading", - "description": "The heading component renders hierarchical titles to communicate the structure and organization of page content. Use heading to create section titles and content headers that help users understand information hierarchy and navigate content.\n\nHeading levels adjust automatically based on nesting within parent [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section) components, ensuring meaningful and accessible page outlines without manual level management.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "heading-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "HeadingElementProps", - "typeDefinitions": { - "HeadingElementProps": { - "filePath": "src/surfaces/checkout/components/Heading.ts", - "name": "HeadingElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Heading.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "'heading' | 'none' | 'presentation'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element’s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", - "isOptional": true, - "defaultValue": "'heading'" - }, - { - "filePath": "src/surfaces/checkout/components/Heading.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface HeadingElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "heading-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-heading>Contact</s-heading>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "title": "Useful for", - "type": "Generic", - "anchorLink": "useful-for", - "sectionContent": "- Creating titles and subtitles for your content that are consistent across your app.\n- Helping users with visual impairments navigate through content effectively using assistive technologies like screen readers." - }, - { - "title": "Considerations", - "type": "Generic", - "anchorLink": "considerations", - "sectionContent": "- The level of the heading is automatically determined by how deeply it's nested inside other components, starting from h2.\n- Default to using the `heading` property in `s-section`. The `s-heading` component should only be used if you need to implement a custom layout for your heading in the UI." - }, - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use short headings to make your content scannable.\n- Use plain and clear terms.\n- Don't use jargon or technical language.\n- Don't use different terms to describe the same thing.\n- Don't duplicate content." - } - ] - }, - { - "name": "Icon", - "description": "The icon component renders graphic symbols to visually communicate actions, status, and navigation throughout the interface. Use icon to reinforce button actions, indicate status states, or provide wayfinding cues that help users understand available functionality.\n\nIcons support multiple sizes, tones for semantic meaning, and can be integrated with other components like [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button), [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge), and [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip) to enhance visual communication.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "icon-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Media and visuals", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "IconElementProps", - "typeDefinitions": { - "IconElementProps": { - "filePath": "src/surfaces/checkout/components/Icon.ts", - "name": "IconElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Icon.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Icon.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'small' | 'large' | 'base' | 'small-200' | 'small-100' | 'large-100'", - "description": "Adjusts the size of the icon.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Icon.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the icon, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Icon.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'' | ReducedIconTypes", - "description": "", - "isOptional": true - } - ], - "value": "export interface IconElementProps extends Pick {\n tone?: Extract;\n size?: Extract;\n type?: '' | ReducedIconTypes;\n}" - }, - "ReducedIconTypes": { - "filePath": "src/surfaces/checkout/components/Icon.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedIconTypes", - "value": "'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "icon-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-icon type=\"store\" />\n<s-icon type=\"star\" />\n<s-icon type=\"settings\" />\n<s-icon type=\"image\" />\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Image", - "description": "The image component embeds images within the interface with control over presentation and loading behavior. Use image to visually illustrate concepts, showcase products, display user content, or support tasks and interactions with visual context.\n\nImages support responsive sizing, alt text for accessibility, aspect ratio control, and loading states for progressive enhancement. For small preview images in lists or tables, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/thumbnail). For profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/avatar).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "image-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Media and visuals", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ImageElementProps", - "typeDefinitions": { - "ImageElementProps": { - "filePath": "src/surfaces/checkout/components/Image.ts", - "name": "ImageElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "'img' | 'none' | 'presentation'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'img'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "alt", - "value": "string", - "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more.", - "isOptional": true, - "defaultValue": "`''`" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "aspectRatio", - "value": "`${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`", - "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nFor example, if the value is set as `50 / 100`, the getter returns `50 / 100`. If the value is set as `0.5`, the getter returns `0.5 / 1`.", - "isOptional": true, - "defaultValue": "'1/1'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'fill' | 'auto'", - "description": "The displayed inline width of the image.\n\n- `fill`: the image will takes up 100% of the available inline size.\n- `auto`: the image will be displayed at its natural size.", - "isOptional": true, - "defaultValue": "'fill'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "'eager' | 'lazy'", - "description": "Determines the loading behavior of the image:\n- `eager`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `lazy`: Delays loading the image until it approaches a specified distance from the viewport.", - "isOptional": true, - "defaultValue": "'eager'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "objectFit", - "value": "'contain' | 'cover'", - "description": "Determines how the content of the image is resized to fit its container. The image is positioned in the center of the container.", - "isOptional": true, - "defaultValue": "'contain'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "sizes", - "value": "string", - "description": "A set of media conditions and their corresponding sizes.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "src", - "value": "string", - "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder will be rendered.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "srcSet", - "value": "string", - "description": "A set of image sources and their width or pixel density descriptors.\n\nThis overrides the `src` property.", - "isOptional": true - } - ], - "value": "export interface ImageElementProps extends Pick {\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "ImageProps": { - "filePath": "src/surfaces/checkout/components/Image.ts", - "name": "ImageProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "'img' | 'none' | 'presentation'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'img'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "alt", - "value": "string", - "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more.", - "isOptional": true, - "defaultValue": "`''`" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "aspectRatio", - "value": "`${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`", - "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nFor example, if the value is set as `50 / 100`, the getter returns `50 / 100`. If the value is set as `0.5`, the getter returns `0.5 / 1`.", - "isOptional": true, - "defaultValue": "'1/1'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'fill' | 'auto'", - "description": "The displayed inline width of the image.\n\n- `fill`: the image will takes up 100% of the available inline size.\n- `auto`: the image will be displayed at its natural size.", - "isOptional": true, - "defaultValue": "'fill'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "'eager' | 'lazy'", - "description": "Determines the loading behavior of the image:\n- `eager`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `lazy`: Delays loading the image until it approaches a specified distance from the viewport.", - "isOptional": true, - "defaultValue": "'eager'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "objectFit", - "value": "'contain' | 'cover'", - "description": "Determines how the content of the image is resized to fit its container. The image is positioned in the center of the container.", - "isOptional": true, - "defaultValue": "'contain'" - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "sizes", - "value": "string", - "description": "A set of media conditions and their corresponding sizes.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "src", - "value": "string", - "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder will be rendered.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Image.ts", - "syntaxKind": "PropertySignature", - "name": "srcSet", - "value": "string", - "description": "A set of image sources and their width or pixel density descriptors.\n\nThis overrides the `src` property.", - "isOptional": true - } - ], - "value": "export interface ImageProps extends ImageElementProps {\n}" - } - } - } - ], - "defaultExample": { - "image": "image-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-image src=\"https://cdn.shopify.com/YOUR_IMAGE_HERE\" alt=\"Product image\"></s-image>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use high-resolution images to ensure a professional and high-quality experience.\n- Use optimized images so your app loads as fast as possible.\n- Use images intentionally, these should add clarity and lead users to the next step." - } - ] - }, - { - "name": "Link", - "description": "The link component makes text interactive, allowing users to navigate to other pages or perform specific actions. Use link for navigation, external references, or triggering actions while maintaining standard link semantics and accessibility.\n\nLinks support standard URLs, custom protocols, navigation within Shopify admin pages, and can open in new windows for external destinations. For prominent actions or form submissions, use [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) instead.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "link-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Actions", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "LinkElementProps", - "typeDefinitions": { - "LinkElementProps": { - "filePath": "src/surfaces/checkout/components/Link.ts", - "name": "LinkElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Link. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the content of the link is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral'", - "description": "Sets the tone of the Link, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface LinkElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "LinkElementEvents", - "typeDefinitions": { - "LinkElementEvents": { - "filePath": "src/surfaces/checkout/components/Link.ts", - "name": "LinkElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Callback when the link is activated. This will be called before navigating to the location specified by `href`.", - "isOptional": true - } - ], - "value": "export interface LinkElementEvents {\n /**\n * Callback when the link is activated.\n * This will be called before navigating to the location specified by `href`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Link.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "link-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-link href=\"https://www.shopify.com/ca/legal/privacy\">Privacy policy</s-link>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use links primarily for navigation and use buttons primarily for actions.\n\n- The HTML that renders for the `s-button` and `s-link` components includes style and accessibility information. Use these components intentionally and consistently to provide a more inclusive experience for assistive technology users and a more cohesive visual experience for sighted users.\n " - } - ] - }, - { - "name": "Map", - "description": "Use Map to display a map on a page. This component is useful for displaying a map of a location, such as a store or a customer’s address.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "map-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Interactive", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "MapElementProps", - "typeDefinitions": { - "MapElementProps": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "name": "MapElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the map.\n\nWhen set, it will be announced to users using assistive technologies and will provide them with more context.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "apiKey", - "value": "string", - "description": "A valid API key for the map service provider.\n\nThe map service provider may require an API key. Without an API key the map could be hidden or render in a limited developer mode.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "latitude", - "value": "number", - "description": "Map center’s latitude in degrees.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "longitude", - "value": "number", - "description": "Map center’s longitude in degrees.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "maxZoom", - "value": "number", - "description": "The maximum zoom level which will be displayed on the map.\n\nValid zoom values are numbers from zero up to 18.", - "isOptional": true, - "defaultValue": "18" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "minZoom", - "value": "number", - "description": "The minimum zoom level which will be displayed on the map.\n\nValid zoom values are numbers from zero up to 18.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "zoom", - "value": "number", - "description": "The initial Map zoom level.\n\nValid zoom values are numbers from zero up to 18. Larger zoom values correspond to a higher resolution.", - "isOptional": true, - "defaultValue": "4" - } - ], - "value": "export interface MapElementProps extends Pick {\n}" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "MapElementEvents", - "typeDefinitions": { - "MapElementEvents": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "name": "MapElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "boundschange", - "value": "CallbackEventListener", - "description": "Callback when the viewport bounds have changed or the map is resized.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Callback when the user clicks on the map.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "dblclick", - "value": "CallbackEventListener", - "description": "Callback when the user double-clicks on the map.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "viewchange", - "value": "CallbackEventListener", - "description": "Callback when the map view changes.", - "isOptional": true - } - ], - "value": "export interface MapElementEvents {\n /**\n * Callback when the viewport bounds have changed or the map is resized.\n */\n boundschange?: CallbackEventListener;\n /**\n * Callback when the user clicks on the map.\n */\n click?: CallbackEventListener;\n /**\n * Callback when the user double-clicks on the map.\n */\n dblclick?: CallbackEventListener;\n /**\n * Callback when the map view changes.\n */\n viewchange?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - }, - "MapBoundsEvent": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "name": "MapBoundsEvent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "bounds", - "value": "{ northEast?: MapLocation; southWest?: MapLocation; }", - "description": "", - "isOptional": true - } - ], - "value": "export interface MapBoundsEvent {\n bounds?: {\n northEast?: MapLocation;\n southWest?: MapLocation;\n };\n}" - }, - "MapLocation": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "name": "MapLocation", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "latitude", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "longitude", - "value": "number", - "description": "", - "isOptional": true - } - ], - "value": "export interface MapLocation {\n latitude?: number;\n longitude?: number;\n}" - }, - "MapLocationEvent": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "name": "MapLocationEvent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "MapLocation", - "description": "", - "isOptional": true - } - ], - "value": "export interface MapLocationEvent {\n location?: MapLocation;\n}" - }, - "MapViewChangeEvent": { - "filePath": "src/surfaces/checkout/components/Map.ts", - "name": "MapViewChangeEvent", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "MapLocation", - "description": "", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Map.ts", - "syntaxKind": "PropertySignature", - "name": "zoom", - "value": "number", - "description": "", - "isOptional": true - } - ], - "value": "export interface MapViewChangeEvent extends MapLocationEvent {\n zoom?: number;\n}" - } - } - }, - { - "title": "MapMarker", - "description": "Use MapMarker to display a marker on a map. Use only as a child of `s-map` component.", - "type": "MapMarkerElementProps", - "typeDefinitions": { - "MapMarkerElementProps": { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "name": "MapMarkerElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the marker. When set, it will be announced to users using assistive technologies and will provide them with more context.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "clusterable", - "value": "boolean", - "description": "Allows grouping the marker in clusters when zoomed out.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "latitude", - "value": "number", - "description": "Marker’s location latitude in degrees.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "longitude", - "value": "number", - "description": "Marker’s longitude latitude in degrees.", - "isOptional": true, - "defaultValue": "0" - } - ], - "value": "export interface MapMarkerElementProps extends Pick {\n command?: Extract;\n}" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "MapMarkerElementEvents", - "typeDefinitions": { - "MapMarkerElementEvents": { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "name": "MapMarkerElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Callback when a marker is clicked.\n\nIt does not trigger a click event on the map itself.", - "isOptional": true - } - ], - "value": "export interface MapMarkerElementEvents {\n /**\n * Callback when a marker is clicked.\n *\n * It does not trigger a click event on the map itself.\n */\n click?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "MapMarkerElementSlots", - "typeDefinitions": { - "MapMarkerElementSlots": { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "name": "MapMarkerElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/MapMarker.ts", - "syntaxKind": "PropertySignature", - "name": "graphic", - "value": "HTMLElement", - "description": "The graphic to use as the marker.\n\nIf unset, it will default to the provider’s default marker.", - "isOptional": true - } - ], - "value": "export interface MapMarkerElementSlots {\n /**\n * The graphic to use as the marker.\n *\n * If unset, it will default to the provider’s default marker.\n */\n graphic?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "map-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-map apiKey=\"YOUR_API_KEY\" latitude={51.5074} longitude={-0.1278}>\n <s-map-marker latitude={51.5074} longitude={-0.1278}></s-map-marker>\n</s-map>\n", - "language": "html" - } - ] - } - }, - "examples": { - "description": "Examples of how to show a custom map marker graphic or a Popover when a map marker is clicked.", - "examples": [ - { - "description": "Use the `Popover` component to display content when a map marker is clicked.", - "codeblock": { - "title": "Popover with map marker", - "tabs": [ - { - "code": "<s-map\n apiKey=\"YOUR_API_KEY\"\n blockSize=\"400px\"\n inlineSize=\"400px\"\n latitude={37.7749}\n longitude={-122.4194}\n>\n <s-map-marker\n latitude={37.7749}\n longitude={-122.4194}\n commandFor=\"popover-san-francisco\"\n ></s-map-marker>\n <s-popover id=\"popover-san-francisco\">San Francisco</s-popover>\n</s-map>\n", - "language": "html" - } - ] - } - }, - { - "description": "Use the `graphic` slot to display a graphic as a map marker. Find more about slots [here](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "codeblock": { - "title": "Map with graphic as map marker", - "tabs": [ - { - "code": "<s-map\n apiKey=\"YOUR_API_KEY\"\n blockSize=\"400px\"\n inlineSize=\"400px\"\n latitude={37.7749}\n longitude={-122.4194}\n>\n <s-map-marker\n latitude={37.7749}\n longitude={-122.4194}\n >\n <s-image src=\"https://cdn.shopify.com/YOUR_IMAGE_HERE\" slot=\"graphic\"></s-image>\n </s-map-marker>\n</s-map>\n", - "language": "html" - } - ] - } - } - ] - }, - "subSections": [] - }, - { - "name": "Modal", - "description": "Displays content in an overlay. Use to create a distraction-free experience such as a confirmation dialog or a settings panel.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "modal-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Overlays", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ModalElementProps", - "typeDefinitions": { - "ModalElementProps": { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "name": "ModalElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the modal. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nThis overrides the `heading` prop for screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "heading", - "value": "string", - "description": "A title that describes the content of the Modal.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "'base' | 'none'", - "description": "Adjust the padding around the Modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`none`: removes all padding from the element. This can be useful when elements inside the Modal need to span to the edge of the Modal. For example, a full-width image. In this case, rely on `Box` with a padding of 'base' to bring back the desired padding for the rest of the content.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100' | 'max'", - "description": "Adjust the size of the Modal.\n\n`max`: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", - "isOptional": true, - "defaultValue": "'base'" - } - ], - "value": "export interface ModalElementProps extends Pick {\n size?: Extract;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "ModalElementEvents", - "typeDefinitions": { - "ModalElementEvents": { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "name": "ModalElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "afterhide", - "value": "CallbackEventListener", - "description": "Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "aftershow", - "value": "CallbackEventListener", - "description": "Callback fired when the overlay is shown **after** any animations to show the overlay have finished.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "hide", - "value": "CallbackEventListener", - "description": "Callback fired after the overlay is hidden.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "show", - "value": "CallbackEventListener", - "description": "Callback fired after the overlay is shown.", - "isOptional": true - } - ], - "value": "export interface ModalElementEvents {\n /**\n * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.\n */\n afterhide?: CallbackEventListener;\n /**\n * Callback fired when the overlay is shown **after** any animations to show the overlay have finished.\n */\n aftershow?: CallbackEventListener;\n /**\n * Callback fired after the overlay is hidden.\n */\n hide?: CallbackEventListener;\n /**\n * Callback fired after the overlay is shown.\n */\n show?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "ModalElementSlots", - "typeDefinitions": { - "ModalElementSlots": { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "name": "ModalElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "primary-action", - "value": "HTMLElement", - "description": "The primary action to perform, provided as a button type element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "secondary-actions", - "value": "HTMLElement", - "description": "The secondary actions to perform, provided as button type elements.", - "isOptional": true - } - ], - "value": "export interface ModalElementSlots {\n /**\n * The primary action to perform, provided as a button type element.\n */\n 'primary-action'?: HTMLElement;\n /**\n * The secondary actions to perform, provided as button type elements.\n */\n 'secondary-actions'?: HTMLElement;\n}" - } - } - }, - { - "title": "Methods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", - "type": "ModalElementMethods", - "typeDefinitions": { - "ModalElementMethods": { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "name": "ModalElementMethods", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Modal.ts", - "syntaxKind": "PropertySignature", - "name": "hideOverlay", - "value": "() => void", - "description": "Method to hide an overlay." - } - ], - "value": "export interface ModalElementMethods extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "modal-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-button command=\"--show\" commandfor=\"modal-1\">Add Product</s-button>\n<s-modal id=\"modal-1\" heading=\"Return Policy\">\n <s-paragraph>\n We have a 30-day return policy, which means you have 30 days after receiving\n your item to request a return.\n </s-paragraph>\n <s-paragraph>\n To be eligible for a return, your item must be in the same condition that\n you received it, unworn or unused, with tags, and in its original packaging.\n You’ll also need the receipt or proof of purchase.\n </s-paragraph>\n <s-button\n variant=\"primary\"\n command=\"--hide\"\n commandfor=\"modal-1\"\n slot=\"primary-action\"\n >\n Close\n </s-button>\n</s-modal>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Money field", - "description": "The money field component collects monetary values from users with built-in currency formatting and validation. Use money field for prices, costs, or financial amounts to provide proper currency symbols, decimal handling, and numeric validation.\n\nMoney fields support currency codes, automatic formatting, and min/max constraints to ensure users enter valid monetary values. For non-currency numeric input, use [number field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/number-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "money-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "MoneyFieldElementProps", - "typeDefinitions": { - "MoneyFieldElementProps": { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "name": "MoneyFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "max", - "value": "number", - "description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number.\n\nNote: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "min", - "value": "number", - "description": "The lowest decimal or integer to be accepted for the field. When used with `step` the value will round up to the min number.\n\nNote: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation.", - "isOptional": true, - "defaultValue": "-Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "step", - "value": "number", - "description": "The amount the value can increase or decrease by. This can be an integer or decimal. If a `max` or `min` is specified with `step` when increasing/decreasing the value via the buttons, the final value will always round to the `max` or `min` rather than the closest valid amount.", - "isOptional": true, - "defaultValue": "1" - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface MoneyFieldElementProps extends Pick {\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "MoneyFieldElementEvents", - "typeDefinitions": { - "MoneyFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "name": "MoneyFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface MoneyFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/MoneyField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "money-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-money-field label=\"Price\" defaultValue=\"9.99\"></s-money-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Number field", - "description": "The number field component captures numeric input with built-in number validation. Use it to collect quantities, prices, or other numeric information.\n\nThe component supports min/max constraints and step increments for guided numeric entry. For monetary values with currency formatting, use [money field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/money-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "number-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "NumberFieldElementProps", - "typeDefinitions": { - "NumberFieldElementProps": { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "name": "NumberFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "controls", - "value": "'auto' | 'stepper' | 'none'", - "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | 'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "The type of icon to be displayed in the field.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "'decimal' | 'numeric'", - "description": "Sets the virtual keyboard.", - "isOptional": true, - "defaultValue": "'decimal'" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "max", - "value": "number", - "description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number.\n\nNote: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "min", - "value": "number", - "description": "The lowest decimal or integer to be accepted for the field. When used with `step` the value will round up to the min number.\n\nNote: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation.", - "isOptional": true, - "defaultValue": "-Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "step", - "value": "number", - "description": "The amount the value can increase or decrease by. This can be an integer or decimal. If a `max` or `min` is specified with `step` when increasing/decreasing the value via the buttons, the final value will always round to the `max` or `min` rather than the closest valid amount.", - "isOptional": true, - "defaultValue": "1" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface NumberFieldElementProps extends Pick {\n icon?: IconProps['type'];\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "NumberFieldElementEvents", - "typeDefinitions": { - "NumberFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "name": "NumberFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface NumberFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "NumberFieldElementSlots", - "typeDefinitions": { - "NumberFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "name": "NumberFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/NumberField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface NumberFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "number-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-number-field\n label=\"Quantity\"\n controls=\"stepper\"\n defaultValue=\"1\"\n step={1}\n min={0}\n max={100}\n></s-number-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Ordered list", - "description": "The ordered list component displays a numbered list of related items in a specific sequence. Use ordered list to present step-by-step instructions, ranked items, procedures, or any content where order and sequence matter to understanding.\n\nOrdered lists automatically number items and support nested lists for hierarchical content organization. For items where order doesn't matter, use [unordered list](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/unordered-list).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "ordered-list-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "OrderedListElementProps", - "typeDefinitions": { - "OrderedListElementProps": { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "name": "OrderedListElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface OrderedListElementProps extends OrderedListProps$1 {\n}" - } - } - }, - { - "title": "List item", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", - "type": "ListItemElementProps", - "typeDefinitions": { - "ListItemElementProps": { - "filePath": "src/surfaces/checkout/components/ListItem.ts", - "name": "ListItemElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ListItem.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface ListItemElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "ordered-list-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-ordered-list>\n <s-list-item>Add items to your cart</s-list-item>\n <s-list-item>Review your order details</s-list-item>\n <s-list-item>Complete your purchase</s-list-item>\n</s-ordered-list>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use `s-ordered-list` when you need to present items in a specific sequence or order.\n- Each item in the list should be wrapped in a `s-list-item` component.\n- Keep list items concise and consistent in length when possible.\n- Use `s-ordered-list` for step-by-step instructions, numbered procedures, or ranked items.\n- Consider using `s-ordered-list` when the order of items is important for understanding." - } - ] - }, - { - "name": "Paragraph", - "description": "The paragraph component displays blocks of text content and can contain inline elements like buttons, links, or emphasized text. Use paragraph to present standalone blocks of readable content, descriptions, or explanatory text.\n\nParagraphs support alignment options and can wrap inline components to create rich, formatted content blocks. For inline text styling, use [text](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/text).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "paragraph-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ParagraphElementProps", - "typeDefinitions": { - "ParagraphElementProps": { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "name": "ParagraphElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Paragraph.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", - "isOptional": true, - "defaultValue": "'paragraph'" - } - ], - "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n}" - }, - "ParagraphType": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ParagraphType", - "value": "\"paragraph\" | \"small\"", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "paragraph-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-paragraph>Ship in 1-2 business days.</s-paragraph>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "- Create contrast between more and less important text with properties such as `color` and `tone`." - } - ] - }, - { - "name": "Password field", - "description": "The password field component securely collects sensitive information from users. Use password field for password entry, where input characters are automatically masked for privacy.\n\nPassword fields support validation, help text, and accessibility features to create secure and user-friendly authentication experiences. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "password-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "PasswordFieldElementProps", - "typeDefinitions": { - "PasswordFieldElementProps": { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "name": "PasswordFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface PasswordFieldElementProps extends Pick {\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "PasswordFieldElementEvents", - "typeDefinitions": { - "PasswordFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "name": "PasswordFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface PasswordFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "PasswordFieldElementSlots", - "typeDefinitions": { - "PasswordFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "name": "PasswordFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PasswordField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface PasswordFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "password-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-password-field label=\"Password\" defaultValue=\"12345678\"></s-password-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Payment icon", - "description": "Displays icons representing payment methods. Use to visually communicate available or saved payment options clearly", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "payment-icon-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Media and visuals", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "PaymentIconElementProps", - "typeDefinitions": { - "PaymentIconElementProps": { - "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", - "name": "PaymentIconElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the icon.\n\nWhen set, it will be announced to users using assistive technologies and will provide them with more context. This should only be used if the icon requires an alternative internationalised label or if it is otherwise inappropriate to make use of the default label included with the icon.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "PaymentIconName | AnyString", - "description": "The icon type of the payment method", - "isOptional": true, - "defaultValue": "''" - } - ], - "value": "export interface PaymentIconElementProps extends PaymentIconProps$1 {\n}" - }, - "PaymentIconName": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaymentIconName", - "value": "\"abn\" | \"acima-leasing\" | \"acuotaz\" | \"ada\" | \"addi\" | \"adyen\" | \"aeropay\" | \"affin-bank\" | \"affirm\" | \"aftee\" | \"afterpay-paynl-version\" | \"afterpay\" | \"airtel-money\" | \"airteltigo-mobile-money\" | \"aktia\" | \"akulaku-paylater\" | \"akulaku\" | \"alandsbanken\" | \"alfamart\" | \"alfamidi\" | \"alipay-hk\" | \"alipay-paynl-version\" | \"alipay\" | \"alliance-bank\" | \"alma\" | \"aman\" | \"amazon\" | \"ambank\" | \"american-express\" | \"amex\" | \"ansa-stored-value\" | \"ansa\" | \"anyday\" | \"apecoin\" | \"aplazo\" | \"apple-pay\" | \"aqsat\" | \"arbitrum\" | \"arhaus\" | \"arvato\" | \"ashley-plcc\" | \"ask\" | \"astrapay\" | \"atm-bersama\" | \"atobaraidotcom\" | \"atome\" | \"atone\" | \"atrato\" | \"au-kantan-kessai\" | \"au-pay\" | \"authorize-net\" | \"avalanche\" | \"axs\" | \"bancnet\" | \"banco-azteca\" | \"bancomat\" | \"bancontact\" | \"bangkok-bank\" | \"bank-islam\" | \"bank-muamalat\" | \"bank-rakyat\" | \"barclays\" | \"base\" | \"bbva-cie\" | \"bc-card\" | \"bca-klikpay\" | \"bca\" | \"bdo\" | \"belfius\" | \"benefit\" | \"best-buy-card\" | \"biercheque-paynl-version\" | \"bigc\" | \"billease\" | \"biller-paynl-version\" | \"billie\" | \"billink-method\" | \"billink\" | \"bitcoin-cash\" | \"bitcoin\" | \"bizum\" | \"blik\" | \"bnbchain\" | \"bni\" | \"bnp\" | \"bogus-app-coin\" | \"bogus\" | \"boleto\" | \"boodil\" | \"boost\" | \"bpi\" | \"braintree\" | \"bread-pay\" | \"bread\" | \"bri-direct-debit\" | \"bri\" | \"brimo\" | \"bsi\" | \"bsn\" | \"bss\" | \"busd\" | \"careem-pay\" | \"cartes-bancaires\" | \"cash-app-pay\" | \"cash\" | \"cashew\" | \"cashinvoice-latin-america\" | \"catch-payments\" | \"cebuana\" | \"cembrapay\" | \"centi\" | \"cetelem\" | \"checkout-finance\" | \"chinabank\" | \"cimb-clicks\" | \"cimb\" | \"circle-k\" | \"citadele\" | \"citi-pay\" | \"clave-telered\" | \"clearpay\" | \"clerq\" | \"cleverpay\" | \"clip\" | \"cliq\" | \"codensa\" | \"coinsph\" | \"collector-bank\" | \"coop\" | \"coppel-pay\" | \"credit-agricole\" | \"credit-key\" | \"creditclick-paynl-version\" | \"credix\" | \"cuotas\" | \"d-barai\" | \"dai\" | \"daily-yamazaki\" | \"dan-dan\" | \"dana\" | \"danamon-online\" | \"dankort\" | \"danske-bank\" | \"dappmx\" | \"dash\" | \"daviplata\" | \"de-cadeaukaart\" | \"depay\" | \"deutsche-bank\" | \"dinacard\" | \"diners-club\" | \"direct-bank-transfer-latin-america\" | \"directa24\" | \"directpay\" | \"discover\" | \"divido\" | \"dnb\" | \"docomo-barai\" | \"dogecoin\" | \"dropp\" | \"duitnow\" | \"duologi\" | \"dwolla\" | \"easywallet\" | \"ebucks\" | \"echelon-financing\" | \"ecpay\" | \"edenred\" | \"efecty\" | \"eft-secure\" | \"eftpos-au\" | \"eghl\" | \"elo\" | \"elv\" | \"empty\" | \"enets\" | \"eos\" | \"epayments\" | \"epospay\" | \"eps\" | \"erste\" | \"escrowcom\" | \"esr-paymentslip-switzerland\" | \"ethereum\" | \"etihad-guest-pay\" | \"etika\" | \"ewallet-indonesia\" | \"ewallet-philippines\" | \"ewallet-southkorea\" | \"facebook-pay\" | \"fairstone-payments\" | \"fam\" | \"familymart\" | \"fantom\" | \"farmlands\" | \"fashion-giftcard-paynlversion\" | \"fashioncheque\" | \"favepay\" | \"fawry\" | \"finloup\" | \"fintecture\" | \"fintoc\" | \"flexiti\" | \"float-payments\" | \"flying-blue-plus\" | \"forbrugsforeningen\" | \"forsa\" | \"fortiva\" | \"fps\" | \"fpx\" | \"freecharge\" | \"freedompay\" | \"futurepay-mytab\" | \"gcash\" | \"generalfinancing\" | \"generic\" | \"genoapay\" | \"gezondheidsbon-paynl-version\" | \"giftcard\" | \"giropay\" | \"givacard\" | \"glbe-paypal\" | \"glbe-plus\" | \"gmo-atokara\" | \"gmo-bank-transfer\" | \"gmo-postpay\" | \"gmo-virtualaccount\" | \"gnosis\" | \"google-pay\" | \"google-wallet\" | \"gopay\" | \"grabpay\" | \"grailpay\" | \"gusd\" | \"hana-card\" | \"handelsbanken\" | \"happy-pay\" | \"hello-clever\" | \"heylight\" | \"hitrustpay-transfer\" | \"home-credit\" | \"hong-leong-bank\" | \"hong-leong-connect\" | \"hsbc\" | \"huis-tuin-cadeau\" | \"humm\" | \"hyper\" | \"hypercard\" | \"hypercash\" | \"hyundai-card\" | \"ibexpay\" | \"ideal\" | \"in3-via-ideal\" | \"in3\" | \"inbank\" | \"indomaret\" | \"ing-homepay\" | \"interac\" | \"ivy\" | \"iwocapay-pay-later\" | \"jcb\" | \"jenius\" | \"jko\" | \"jousto\" | \"kakao-pay\" | \"kakebaraidotcom\" | \"kasikornbank\" | \"kasssh\" | \"katapult\" | \"kb-card\" | \"kbc-cbc\" | \"kcp-credit-card\" | \"kfast\" | \"khqr\" | \"klarna-pay-later\" | \"klarna-pay-now\" | \"klarna-slice-it\" | \"klarna\" | \"knaken-settle\" | \"knet\" | \"koalafi\" | \"koin\" | \"krediidipank\" | \"kredivo\" | \"krungsri\" | \"krungthai-bank\" | \"kueski-pay\" | \"kunst-en-cultuur-cadeaukaart\" | \"kuwait-finance-house\" | \"land-bank\" | \"laser\" | \"latitude-creditline-au\" | \"latitude-gem-au\" | \"latitude-gem-nz\" | \"latitude-go-au\" | \"latitudepay\" | \"lawson\" | \"laybuy-heart\" | \"laybuy\" | \"lbc\" | \"lhv\" | \"line-pay\" | \"linkaja\" | \"linkpay\" | \"litecoin\" | \"lku\" | \"lloyds\" | \"lotte-card\" | \"lpb\" | \"luminor\" | \"lunch-check\" | \"lydia\" | \"mach\" | \"mada\" | \"maestro\" | \"mandiri\" | \"mash\" | \"master\" | \"mastercard\" | \"masterpass\" | \"maxima\" | \"maya-bank\" | \"maya\" | \"maybank-qrpay\" | \"maybank\" | \"maybankm2u\" | \"mb-way\" | \"mb\" | \"mcash\" | \"medicinos-bankas\" | \"meeza\" | \"mercado-credito\" | \"mercado-pago\" | \"merpay\" | \"meta-pay\" | \"metro-bank\" | \"military-starcard\" | \"minicuotas\" | \"ministop\" | \"mobicred\" | \"mobikwik\" | \"mobilepay\" | \"mode\" | \"mokka\" | \"momopay\" | \"mondido\" | \"monero\" | \"monzo\" | \"mpesa\" | \"mtn-mobile-money\" | \"multisafepay\" | \"mybank\" | \"myfatoorah\" | \"n26\" | \"naps\" | \"nationale-bioscoopbon\" | \"nationale-entertainmentcard\" | \"natwest\" | \"naver-pay\" | \"nelo\" | \"nequi\" | \"netbanking\" | \"neteller\" | \"nh-card\" | \"nordea\" | \"notyd\" | \"novuna\" | \"npatobarai\" | \"npkakebarai\" | \"oca\" | \"ocbc-bank\" | \"octo-clicks\" | \"octopus\" | \"offline-bank-transfer-latin-america\" | \"ola-money\" | \"omannet\" | \"omasp\" | \"oney\" | \"online-banking\" | \"online-banktransfer\" | \"op\" | \"opay\" | \"openpay\" | \"optimism\" | \"orange-mobile-money\" | \"overstock-citicobrand\" | \"overstock-citiplcc\" | \"ovo\" | \"oxxo\" | \"ozow\" | \"pagoefectivo\" | \"paid\" | \"paidy\" | \"palawa\" | \"palawan\" | \"pastpay\" | \"pay-after-delivery-instalments\" | \"pay-by-bank-us\" | \"pay-by-bank\" | \"pay-easy\" | \"pay-pay\" | \"paybylink\" | \"paycash\" | \"payco\" | \"payconiq\" | \"payd\" | \"payfast-instant-eft\" | \"payflex\" | \"payid\" | \"payitmonthly\" | \"payjustnow\" | \"paymark-online-eftpos\" | \"paymaya\" | \"payme\" | \"paynow-mbank\" | \"paynow\" | \"payoo-qr\" | \"payoo\" | \"paypal\" | \"payplan\" | \"paypo\" | \"payrexx-bank-transfer\" | \"payright\" | \"paysafecard-paynl-version\" | \"paysafecard\" | \"paysafecash\" | \"paysera\" | \"paysquad\" | \"paytm\" | \"payto\" | \"paytomorrow\" | \"payu\" | \"payzapp\" | \"pei\" | \"perlasfinance\" | \"permata\" | \"pf-pay\" | \"pivo\" | \"pix\" | \"podium-cadeaukaart\" | \"pointspay\" | \"poli\" | \"polygon\" | \"poppankki\" | \"postfinance-card\" | \"postfinance-efinance\" | \"postpay\" | \"powered-by-ansa-stored-value\" | \"powered-by-ansa\" | \"powerpay\" | \"pps\" | \"prepaysolutions\" | \"progressive-leasing\" | \"przelew24\" | \"przelewy24-paynl-version\" | \"przelewy24\" | \"pse\" | \"public-bank\" | \"publicbank-pbe\" | \"qasitli\" | \"qliro\" | \"qr-promptpay\" | \"qris\" | \"qrph\" | \"rabbit-line-pay\" | \"rabobank\" | \"rakuten-pay\" | \"rapid-transfer\" | \"ratepay\" | \"raty-pekao\" | \"rcbc\" | \"rcs\" | \"reka\" | \"resolve-pay\" | \"revolut\" | \"rhb-bank\" | \"rhb-now\" | \"rietumu\" | \"riverty-paynl-version\" | \"riverty\" | \"rupay\" | \"saastopankki\" | \"sadad\" | \"sam\" | \"samsung-card\" | \"samsung-pay\" | \"santander\" | \"satisfi\" | \"satispay\" | \"sbpl\" | \"scalapay\" | \"scream-truck-wallet\" | \"scream-truck\" | \"seb\" | \"seicomart\" | \"sepa-bank-transfer\" | \"sepa-direct-debit\" | \"sequra\" | \"seven-eleven\" | \"sezzle\" | \"shib\" | \"shinhan-card\" | \"shop-pay\" | \"shopeepay\" | \"shopify-pay\" | \"siam-commercial\" | \"siauliu-bankas\" | \"siirto\" | \"sika-fsa\" | \"sika-hsa\" | \"sika\" | \"simpl\" | \"simple-pay\" | \"sinpe-movil\" | \"sistecredito\" | \"skeps\" | \"skrill-digital-wallet\" | \"slice-fnbo\" | \"smartpay\" | \"snap-checkout\" | \"snapmint\" | \"societe-generale\" | \"sofort\" | \"softbank\" | \"solana-pay-helio\" | \"solana-pay\" | \"solana\" | \"souhoola\" | \"spankki\" | \"sparkasse\" | \"spei\" | \"splitit\" | \"spotii\" | \"spraypay\" | \"standard-chartered\" | \"stc-pay\" | \"stoov\" | \"store-credit\" | \"stripe\" | \"sunkus\" | \"super-payments\" | \"svea-b2b-faktura\" | \"svea-b2b-invoice\" | \"svea-checkout\" | \"svea-credit-account\" | \"svea-delbetalning\" | \"svea-faktura\" | \"svea-invoice\" | \"svea-lasku\" | \"svea-ostukonto\" | \"svea-part-payment\" | \"svea-yrityslasku\" | \"sveaeramaksu\" | \"swedbank\" | \"swiftpay\" | \"swish\" | \"swissbilling\" | \"sympl\" | \"synchrony-pay\" | \"synchrony\" | \"tabby\" | \"tabit\" | \"taly\" | \"tamara\" | \"tandympayment\" | \"tasa-cero\" | \"tbi-bank\" | \"tcf\" | \"tendopay\" | \"tensile\" | \"tesco-lotus\" | \"thanachart-bank\" | \"timepayment\" | \"tiptop\" | \"todopay\" | \"toss\" | \"touch-n-go\" | \"tpay\" | \"trevipay\" | \"truelayer\" | \"truemoney-pay\" | \"trustly\" | \"twig-pay\" | \"twint\" | \"twoinvoice\" | \"uae-visa\" | \"uangme\" | \"ubp\" | \"underpay\" | \"unionpay\" | \"unipay\" | \"uob-ez-pay\" | \"uob-thai\" | \"uob\" | \"upi\" | \"urbo\" | \"urpay\" | \"usdc\" | \"usdp\" | \"v-pay\" | \"valu\" | \"venmo\" | \"ventipay\" | \"venus-plcc\" | \"viabill\" | \"vipps\" | \"visa-electron\" | \"visa\" | \"volksbank\" | \"volt\" | \"vvv-cadeaukaart-paynl-version\" | \"vvv-giftcard\" | \"waave-pay-by-bank\" | \"wallet\" | \"walley\" | \"wbtc\" | \"webshop-giftcard\" | \"wechat-pay\" | \"wechat-paynl-version\" | \"wegetfinancing\" | \"whish-checkout\" | \"whish-pay\" | \"wise\" | \"wissel\" | \"world-chain\" | \"xrp\" | \"yape\" | \"yappy\" | \"ymobile\" | \"younited-pay\" | \"zalopay\" | \"zapper\" | \"zingala\" | \"zinia\" | \"zip\" | \"zoodpay\" | \"zulily-credit-card\" | \"zustaina\"", - "description": "" - }, - "AnyString": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnyString", - "value": "string & {}", - "description": "Prevents widening string literal types in a union to `string`." - } - } - } - ], - "defaultExample": { - "image": "payment-icon-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-payment-icon type=\"paypal\" />\n<s-payment-icon type=\"apple-pay\" />\n<s-payment-icon type=\"mastercard\" />\n<s-payment-icon type=\"shop-pay\" />\n<s-payment-icon type=\"visa\" />\n<s-payment-icon type=\"amex\" />\n<s-payment-icon type=\"klarna\" />\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Phone field", - "description": "Use PhoneField to allow users to enter phone numbers.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "phone-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "PhoneFieldElementProps", - "typeDefinitions": { - "PhoneFieldElementProps": { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "name": "PhoneFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", - "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" - }, - { - "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface PhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "PhoneFieldElementEvents", - "typeDefinitions": { - "PhoneFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "name": "PhoneFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface PhoneFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "PhoneFieldElementSlots", - "typeDefinitions": { - "PhoneFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "name": "PhoneFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PhoneField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface PhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "phone-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-phone-field label=\"Phone number\" defaultValue=\"888-746-7439\">\n</s-phone-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Popover", - "description": "Popovers are used to display content in an overlay that can be triggered by a button.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "popover-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Overlays", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "PopoverElementProps", - "typeDefinitions": { - "PopoverElementProps": { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "name": "PopoverElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "SizeUnitsOrAuto", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "SizeUnitsOrAuto", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "SizeUnitsOrNone", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "SizeUnitsOrNone", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "SizeUnits", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "SizeUnits", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - } - ], - "value": "export interface PopoverElementProps extends Pick {\n /**\n * Adjust the block size.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size\n *\n * @default 'auto'\n */\n blockSize?: SizeUnitsOrAuto;\n /**\n * Adjust the inline size.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size\n *\n * @default 'auto'\n */\n inlineSize?: SizeUnitsOrAuto;\n /**\n * Adjust the maximum block size.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size\n *\n * @default 'none'\n */\n maxBlockSize?: SizeUnitsOrNone;\n /**\n * Adjust the maximum inline size.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size\n *\n * @default 'none'\n */\n maxInlineSize?: SizeUnitsOrNone;\n /**\n * Adjust the minimum block size.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size\n *\n * @default '0'\n */\n minBlockSize?: SizeUnits;\n /**\n * Adjust the minimum inline size.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size\n *\n * @default '0'\n */\n minInlineSize?: SizeUnits;\n}" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "PopoverElementEvents", - "typeDefinitions": { - "PopoverElementEvents": { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "name": "PopoverElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "hide", - "value": "CallbackEventListener", - "description": "Callback fired after the overlay is hidden.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "PropertySignature", - "name": "show", - "value": "CallbackEventListener", - "description": "Callback fired after the overlay is shown.", - "isOptional": true - } - ], - "value": "export interface PopoverElementEvents {\n /**\n * Callback fired after the overlay is hidden.\n */\n hide?: CallbackEventListener;\n /**\n * Callback fired after the overlay is shown.\n */\n show?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Popover.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "popover-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-button commandFor=\"popover-veteran-id\">Open Popover</s-button>\n<s-popover id=\"popover-veteran-id\">\n <s-stack gap=\"base\" padding=\"base\" direction=\"inline\">\n <s-text-field label=\"Veteran ID\"></s-text-field>\n <s-button variant=\"primary\">Validate</s-button>\n </s-stack>\n</s-popover>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Press button", - "description": "Allows users to toggle between active/inactive states. Use to represent a persistent on/off or selected/unselected status.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "press-button-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Actions", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "PressButtonElementProps", - "typeDefinitions": { - "PressButtonElementProps": { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "name": "PressButtonElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the Button text is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "defaultPressed", - "value": "boolean", - "description": "Whether the button is pressed by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the Button meaning it cannot be clicked or receive focus.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The displayed inline width of the Button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator while a background action is being performed.\n\nThis also disables the Button.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "Whether the button is pressed.", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface PressButtonElementProps extends Pick {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "PressButtonElementEvents", - "typeDefinitions": { - "PressButtonElementEvents": { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "name": "PressButtonElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the button has lost focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "Callback when the button is activated.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the button has received focus.", - "isOptional": true - } - ], - "value": "export interface PressButtonElementEvents {\n /**\n * Callback when the button is activated.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n /**\n * Callback when the button has lost focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the button has received focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/PressButton.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "press-button-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-press-button>Add gift wrapping</s-press-button>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Product thumbnail", - "description": "Use ProductThumbnail to display a product thumbnail", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "product-thumbnail-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Media and visuals", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ProductThumbnailElementProps", - "typeDefinitions": { - "ProductThumbnailElementProps": { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "name": "ProductThumbnailElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "syntaxKind": "PropertySignature", - "name": "alt", - "value": "string", - "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more.", - "isOptional": true, - "defaultValue": "`''`" - }, - { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'small' | 'base' | 'small-100'", - "description": "Adjusts the size the product thumbnail image.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "syntaxKind": "PropertySignature", - "name": "sizes", - "value": "string", - "description": "A set of media conditions and their corresponding sizes.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "syntaxKind": "PropertySignature", - "name": "src", - "value": "string", - "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder will be rendered.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "syntaxKind": "PropertySignature", - "name": "srcSet", - "value": "string", - "description": "A set of image sources and their width or pixel density descriptors.\n\nThis overrides the `src` property.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", - "syntaxKind": "PropertySignature", - "name": "totalItems", - "value": "number", - "description": "Decorates the product thumbnail with the quantity of the product.", - "isOptional": true - } - ], - "value": "export interface ProductThumbnailElementProps extends Pick {\n size?: Extract;\n}" - } - } - } - ], - "defaultExample": { - "image": "product-thumbnail-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-product-thumbnail\n src=\"https://cdn.shopify.com/YOUR_IMAGE_HERE\"\n totalItems={2}\n></s-product-thumbnail>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Progress", - "description": "Displays an indicator showing the completion status of a task. Use to visually communicate progress in either determinate (known percentage) or indeterminate (unknown duration) states.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "progress-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Feedback and status indicators", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ProgressElementProps", - "typeDefinitions": { - "ProgressElementProps": { - "filePath": "src/surfaces/checkout/components/Progress.ts", - "name": "ProgressElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Progress.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Progress.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Progress.ts", - "syntaxKind": "PropertySignature", - "name": "max", - "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", - "isOptional": true, - "defaultValue": "1" - }, - { - "filePath": "src/surfaces/checkout/components/Progress.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Progress.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", - "isOptional": true - } - ], - "value": "export interface ProgressElementProps extends Pick {\n tone?: Extract;\n}" - } - } - } - ], - "defaultExample": { - "image": "progress-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-progress value={0.5}></s-progress>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\nUse components like [Paragraph](../titles-and-text/paragraph) or [Text](../titles-and-text/text), along with the Progress component, to display text indicating the status of the progress bar.\n\n### Loading states\n\nFor loading states, add text to reassure the user that the progress bar is not frozen.\n\n![A progress bar with \"Loading\" text](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-loading.png)\n\n### Error states\n\nFor error states, add text or a [Banner](./banner) to describe the error and next steps. Use the `critical` tone property to convey urgency.\n\n![A progress bar with error text that says \"There was a problem with the file upload. Please try again.\"](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-error.png)\n\n### Visualize a goal\n\nUse the Progress component to visualize a goal that's valuable to the customer.\n\nHere's an example of using a progress bar to show a customer's progress toward the next rewards tier:\n\n![A progress bar in customer accounts, showing that the customer is on their way to reaching the Botanical maven rewards tier.](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-goal.png)\n\nHere's an example of using a progress bar to show how much more a customer needs to spend to get free shipping:\n\n![A progress bar at checkout, showing that the customer is $43 away from free shipping.](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-free-shipping.png)\n " - } - ] - }, - { - "name": "QR Code", - "description": "Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "qr-code-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Other", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "QRCodeElementProps", - "typeDefinitions": { - "QRCodeElementProps": { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "name": "QRCodeElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the QR code. When set, it will be announced to users using assistive technologies and will provide more context about what the QR code may do when scanned.", - "isOptional": true, - "defaultValue": "'QR code' (translated to the user's locale)" - }, - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "'base' | 'none'", - "description": "Set the border of the QR code.\n\n`base`: applies border that is appropriate for the element. `none`: removes the border from the element.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "The content to be encoded in the QR code, which can be any string such as a URL, email address, plain text, etc. Specific string formatting can trigger actions on the user's device when scanned, like opening geolocation coordinates on a map, opening a preferred app or app store entry, preparing an email, text message, and more.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "logo", - "value": "string", - "description": "URL of an image to be displayed in the center of the QR code. This is useful for branding or to indicate to the user what scanning the QR code will do. By default, no image is displayed.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "onError", - "value": "(event: Event) => void", - "description": "Invoked when the conversion of `content` to a QR code fails. If an error occurs, the QR code and its child elements will not be displayed.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'fill'", - "description": "The displayed size of the QR code.\n\n`fill`: the QR code will takes up 100% of the available inline-size and maintain a 1:1 aspect ratio. `base`: the QR code will be displayed at its default size.", - "isOptional": true, - "defaultValue": "'base'" - } - ], - "value": "export interface QRCodeElementProps extends QRCodeProps$1 {\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "QRCodeElementEvents", - "typeDefinitions": { - "QRCodeElementEvents": { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "name": "QRCodeElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "CallbackEventListener", - "description": "Invoked when the conversion of `content` to a QR code fails. If an error occurs, the QR code and its child elements will not be displayed.", - "isOptional": true - } - ], - "value": "export interface QRCodeElementEvents {\n /**\n * Invoked when the conversion of `content` to a QR code fails.\n * If an error occurs, the QR code and its child elements will not be displayed.\n */\n error?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/QRCode.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "qr-code-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-qr-code content=\"https://shopify.com\"></s-qr-code>\n<s-paragraph>\n Scan to visit <s-link href=\"https://shopify.com\">Shopify.com</s-link>\n</s-paragraph>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Always test that the QR code is scannable from a smartphone.\n- Include a square logo if that’s what your customers are familiar with.\n- Increase usability by adding a text description of what the QR code does.\n- Always provide an alternate method for customers to access the content of the QR code.\n- If the content is a URL, provide a [`s-link`](/docs/api/checkout-ui-extensions/components/link) nearby.\n- If the content is data, provide a [`s-button`](/docs/api/checkout-ui-extensions/components/button) to copy the data to the clipboard, or show the data in a readonly [`s-text-field`](/docs/api/checkout-ui-extensions/components/textfield)." - } - ] - }, - { - "name": "Query container", - "description": "The query container component establishes a container query context for responsive design. Use query container to define an element as a containment context, enabling child components or styles to adapt based on the container's size rather than viewport width.\n\nQuery containers support modern responsive patterns where components respond to their container dimensions, creating more flexible and reusable layouts.", - "category": "Polaris web components", - "related": [ - { - "name": "Responsive values", - "subtitle": "Utility", - "url": "/docs/api/checkout-ui-extensions/latest/using-polaris-components#responsive-values", - "type": "utility" - } - ], - "isVisualComponent": true, - "thumbnail": "query-container-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "QueryContainerElementProps", - "typeDefinitions": { - "QueryContainerElementProps": { - "filePath": "src/surfaces/checkout/components/QueryContainer.ts", - "name": "QueryContainerElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/QueryContainer.ts", - "syntaxKind": "PropertySignature", - "name": "containerName", - "value": "string", - "description": "The name of the container, which can be used in your container queries to target this container specifically.\n\nWe place the container name of `s-default` on every container. Because of this, it is not required to add a `containerName` identifier in your queries. For example, a `@container (inline-size <= 300px) none, auto` query is equivalent to `@container s-default (inline-size <= 300px) none, auto`.\n\nAny value set in `containerName` will be set alongside alongside `s-default`. For example, `containerName=\"my-container-name\"` will result in a value of `s-default my-container-name` set on the `container-name` CSS property of the rendered HTML.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/QueryContainer.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface QueryContainerElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "query-container-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-query-container>\n <s-box\n padding=\"@container (inline-size > 500px) large-500, none\"\n background=\"subdued\"\n >\n Padding is applied when the inline-size '>' 500px\n </s-box>\n</s-query-container>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Scroll box", - "description": "Provides a scrollable container for long content that exceeds the available space. Use to display lists, order summaries, or other lengthy content while maintaining a constrained layout.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "scroll-box-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "ScrollBoxElementProps", - "typeDefinitions": { - "ScrollBoxElementProps": { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "name": "ScrollBoxElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderColor", - "value": "'' | 'base'", - "description": "Set the color of the border.\n\nIf set, it takes precedence over the `border` property's color.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.\n- `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.\n\n1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 2 values: `block inline`", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface ScrollBoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" - }, - "AccessibilityRole": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AccessibilityRole", - "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "ScrollBoxProps": { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "name": "ScrollBoxProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderColor", - "value": "'' | 'base'", - "description": "Set the color of the border.\n\nIf set, it takes precedence over the `border` property's color.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.\n- `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.\n\n1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 2 values: `block inline`", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/ScrollBox.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface ScrollBoxProps extends ScrollBoxElementProps {\n}" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - }, - "OverflowKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "OverflowKeyword", - "value": "\"auto\" | \"hidden\"", - "description": "" - }, - "PaddingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaddingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - }, - "SizeKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeKeyword", - "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", - "description": "" - }, - "MaybeTwoValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeTwoValuesShorthandProperty", - "value": "T | `${T} ${T}`", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "scroll-box-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-scroll-box maxBlockSize=\"100px\">\n <s-box background=\"subdued\" border=\"base\" minBlockSize=\"50px\"></s-box>\n <s-box background=\"subdued\" border=\"base\" minBlockSize=\"50px\"></s-box>\n <s-box background=\"subdued\" border=\"base\" minBlockSize=\"50px\"></s-box>\n</s-scroll-box>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Section", - "description": "The section component groups related content into clearly-defined thematic areas with consistent styling and structure. Use section to organize page content into logical blocks, each with its own heading and visual container.\n\nSections automatically adapt their styling based on nesting depth and adjust heading levels to maintain meaningful, accessible page hierarchies. For simple visual separation without headings, use [divider](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/divider).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "section-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "SectionElementProps", - "typeDefinitions": { - "SectionElementProps": { - "filePath": "src/surfaces/checkout/components/Section.ts", - "name": "SectionElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Section.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a children of the Section, you **must** provide an `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide the right context to users.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Section.ts", - "syntaxKind": "PropertySignature", - "name": "heading", - "value": "string", - "description": "A title that describes the content of the section.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Section.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface SectionElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "section-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-section heading=\"Rewards\">\n <s-paragraph>\n Earn 10 points for every $1 spent. Redeem 100 points for $10 off your next\n purchase.\n </s-paragraph>\n</s-section>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "title": "Useful for", - "type": "Generic", - "anchorLink": "useful-for", - "sectionContent": "- Organizing your page in a logical structure based on nesting levels.\n- Creating consistency across pages." - }, - { - "title": "Considerations", - "type": "Generic", - "anchorLink": "considerations", - "sectionContent": "- When adding headings inside sections they automatically use a specific style, which helps keep the content organized and clear." - } - ] - }, - { - "name": "Select", - "description": "The select component allows users to choose one option from a dropdown menu. Use select when presenting four or more choices to keep interfaces uncluttered and scannable, or when space is limited.\n\nSelect components support option grouping, placeholder text, help text, and validation states to create clear selection interfaces. For more visual selection layouts with radio buttons or checkboxes, use [choice list](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/choice-list).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "select-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "SelectElementProps", - "typeDefinitions": { - "SelectElementProps": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "A short hint that describes the expected value of the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface SelectElementProps extends Pick {\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "SelectElementEvents", - "typeDefinitions": { - "SelectElementEvents": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - } - ], - "value": "export interface SelectElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Option", - "description": "Represents a single option within a select component. Use only as a child of `s-select` components.", - "type": "OptionElementProps", - "typeDefinitions": { - "OptionElementProps": { - "filePath": "src/surfaces/checkout/components/Option.ts", - "name": "OptionElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Option.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Option.ts", - "syntaxKind": "PropertySignature", - "name": "defaultSelected", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Option.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Option.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Option.ts", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Option.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface OptionElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "select-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-select label=\"Country/region\">\n <s-option defaultSelected value=\"CA\">Canada</s-option>\n <s-option value=\"US\">United States</s-option>\n <s-option value=\"UK\">United Kingdom</s-option>\n</s-select>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Sheet", - "description": "\nThe Sheet component displays essential information for customers at the bottom of the screen, appearing above other elements. Use it sparingly to avoid distracting customers during checkout. This component requires access to [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be rendered.\n\nThe library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "sheet-thumbnail.png", - "requires": "configuration of the [Customer Privacy](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability to be rendered.", - "type": "", - "subCategory": "Overlays", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "SheetElementProps", - "typeDefinitions": { - "SheetElementProps": { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "name": "SheetElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the modal. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nThis overrides the `heading` prop for screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "defaultOpen", - "value": "boolean", - "description": "Indicates whether the Sheet should be open by default. This property is necessary in some cases, but its usage is generally discouraged due to potential negative impacts on user experience.\n\nDevelopers should:\n- Only set this property to true when there are vitally important behaviors of the application that depend on the user interacting with the sheet.\n- Make every effort to conditionally hide the sheet based on the state of checkout. An explicit example is custom privacy consent, where the sheet should only be displayed when consent is necessary and has not yet been explicitly given by the user.\n\nThis property is useful for when the Sheet needs to be rendered on the page load and not triggered by a user action. The property should only take effect when the `Sheet` is rendered for the first time. To toggle the Sheet after it has been rendered, use the `ui.showOverlay()` method instead.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "heading", - "value": "string", - "description": "A title that describes the content of the sheet.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface SheetElementProps extends Pick {\n /**\n * A label that describes the purpose of the modal. When set,\n * it will be announced to users using assistive technologies and will\n * provide them with more context.\n *\n * This overrides the `heading` prop for screen readers.\n */\n accessibilityLabel?: string;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "SheetElementEvents", - "typeDefinitions": { - "SheetElementEvents": { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "name": "SheetElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "afterhide", - "value": "CallbackEventListener", - "description": "Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "aftershow", - "value": "CallbackEventListener", - "description": "Callback fired when the overlay is shown **after** any animations to show the overlay have finished.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "hide", - "value": "CallbackEventListener", - "description": "Callback fired after the overlay is hidden.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "show", - "value": "CallbackEventListener", - "description": "Callback fired after the overlay is shown.", - "isOptional": true - } - ], - "value": "export interface SheetElementEvents {\n /**\n * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.\n */\n afterhide?: CallbackEventListener;\n /**\n * Callback fired when the overlay is shown **after** any animations to show the overlay have finished.\n */\n aftershow?: CallbackEventListener;\n /**\n * Callback fired after the overlay is hidden.\n */\n hide?: CallbackEventListener;\n /**\n * Callback fired after the overlay is shown.\n */\n show?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "SheetElementSlots", - "typeDefinitions": { - "SheetElementSlots": { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "name": "SheetElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "primary-action", - "value": "HTMLElement", - "description": "The primary action to perform, provided as a button type element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "secondary-actions", - "value": "HTMLElement", - "description": "The secondary actions to perform, provided as a button type element.", - "isOptional": true - } - ], - "value": "export interface SheetElementSlots {\n /**\n * The primary action to perform, provided as a button type element.\n */\n 'primary-action'?: HTMLElement;\n /**\n * The secondary actions to perform, provided as a button type element.\n */\n 'secondary-actions'?: HTMLElement;\n}" - } - } - }, - { - "title": "Methods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", - "type": "SheetElementMethods", - "typeDefinitions": { - "SheetElementMethods": { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "name": "SheetElementMethods", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Sheet.ts", - "syntaxKind": "PropertySignature", - "name": "hideOverlay", - "value": "() => void", - "description": "Method to hide an overlay." - } - ], - "value": "export interface SheetElementMethods extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "sheet-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<!-- This component requires access to Customer Privacy API to be rendered. -->\n<s-button commandFor=\"consent-sheet\">Open Sheet</s-button>\n<s-sheet id=\"consent-sheet\" heading=\"Sheet\" accessibilityLabel=\"A sheet with text content\">\n <s-text>Sheet Content</s-text>\n</s-sheet>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "shopify-controlled-surfaces", - "title": "Shopify-controlled surfaces", - "sectionContent": "To prevent disruptions during checkout, we maintain strict design control over key areas of the Sheet component. These Shopify-controlled elements include:\n\n

Locations of elements

\n\nThe Sheet elements (header, content, action buttons, and dismiss button) are strategically positioned and sized to present vital information upfront.\n\n\"Locations\n\n\"Locations\n\n
\n\n

Padding and spacing

\n\n\"Padding\n\n
\n\n

Maximum height

\n\nTo balance customer attention and task completion, a maximum height is set for the Sheet component.\n\n\"Small\n\n\"Large\n\nWhen content pushes the sheet to exceed this limit, the following UI behaviors are triggered:\n\n
\n\n

Heading and content are scrollable

\n\n\"Heading\n\n
\n\n

Expand pill appears to allow customers to view the entire content

\n\n\"Expand\n\n
\n\n

Actions slot and dismiss button remain fixed

\n\n\"Actions\n" - }, - { - "type": "Generic", - "anchorLink": "privacy-consent-requirements", - "title": "Privacy consent requirements", - "sectionContent": "

Content

\n\nFor the best customer experience, ensure content is brief and to the point.\n\n\"Shows\n\nVarious strategies can be employed to avoid content scrolling.\n\n
\n\n

Use short content

\n\n\"Use\n\n
\n\n

Use small text size

\n\n\"Use\n\n
\n\n

Remove the header

\n\n\"Remove\n\n
\n\n

Actions slot

\n\nThe actions slots allows customers to make decisions and is split into primary and secondary sections.\n\n\"Actions\n\n
\n\n

Primary section

\n\n Contains primary actions for customer decisions on the sheet's prompt. Up to two buttons are allowed. Keep the button's content brief so that it doesn't wrap to more than one line.\n\n\"Primary\n\n
\n\n

Secondary section

\n\nContains action that is unrelated to the sheet's prompt. Only one button is allowed. A modal can be activated when engaging with the secondary action. Keep the button's content brief so that it doesn't wrap to more than one line.\n\n\"Secondary\n\n
\n\n

Consent, denial of consent, and sheet dismissal

\n\n

Consent

\n\nWhen a customer expresses consent by pressing the acceptance button, cookies will load and the sheet should not re-appear on refresh.\n\n
\n\n

Denial of consent

\n\nWhen a customer expresses denial of consent by pressing the rejection button, cookies will not load and the sheet will not re-appear on refresh.\n\n
\n\n

Sheet dismissal

\n\nWhen a customer neither grants nor denies consent by pressing the dismiss button, cookies will not load and the sheet will re-appear on refresh.\n\n\"Sheet" - } - ] - }, - { - "name": "Skeleton paragraph", - "description": "Displays a placeholder representation of text content while it loads. Use to improve perceived performance by showing users where text will appear.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "skeleton-paragraph-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Feedback and status indicators", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "SkeletonParagraphElementProps", - "typeDefinitions": { - "SkeletonParagraphElementProps": { - "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", - "name": "SkeletonParagraphElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", - "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "The content to be used as a base for the skeleton. This content will be hidden when the skeleton is visible.\n\nThis can be useful when the skeleton is representing a known piece of content which is part of a larger element that has not yet fully loaded.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface SkeletonParagraphElementProps extends SkeletonParagraphProps$1 {\n}" - } - } - } - ], - "defaultExample": { - "image": "skeleton-paragraph-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-skeleton-paragraph></s-skeleton-paragraph>\n\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Spinner", - "description": "The spinner component displays an animated indicator showing users that content or actions are loading. Use spinner to communicate ongoing processes like fetching data, processing requests, or waiting for operations to complete.\n\nSpinners support multiple sizes and should be used for page or section loading states. For button loading states, use the `loading` property on the [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) component instead.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "spinner-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Feedback and status indicators", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "SpinnerElementProps", - "typeDefinitions": { - "SpinnerElementProps": { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "name": "SpinnerElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", - "isOptional": true, - "defaultValue": "'base'" - } - ], - "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n size?: Extract;\n}" - } - } - } - ], - "defaultExample": { - "image": "spinner-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-spinner></s-spinner>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Stack", - "description": "The stack component organizes elements horizontally or vertically along the block or inline axis. Use stack to structure layouts, group related components, control spacing between elements, or create flexible arrangements that adapt to content.\n\nStacks support gap spacing, alignment, wrapping, and distribution properties to create consistent, responsive layouts without custom CSS. For complex multi-column layouts with precise grid positioning, use [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "stack-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "StackElementProps", - "typeDefinitions": { - "StackElementProps": { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "name": "StackElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "alignContent", - "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", - "isOptional": true, - "defaultValue": "'normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "alignItems", - "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", - "isOptional": true, - "defaultValue": "'normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "// The following are equivalent:\n\n", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "columnGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "direction", - "value": "MaybeResponsive<\"block\" | \"inline\">", - "description": "Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", - "isOptional": true, - "defaultValue": "'block'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "gap", - "value": "MaybeResponsive>", - "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "justifyContent", - "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", - "isOptional": true, - "defaultValue": "'normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "rowGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface StackElementProps extends Pick {\n accessibilityRole?: Extract;\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n alignContent?: MaybeResponsive>;\n alignItems?: MaybeResponsive>;\n justifyContent?: MaybeResponsive>;\n}" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - }, - "StackProps": { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "name": "StackProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityRole", - "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", - "isOptional": true, - "defaultValue": "'generic'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "alignContent", - "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", - "isOptional": true, - "defaultValue": "'normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "alignItems", - "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", - "isOptional": true, - "defaultValue": "'normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", - "isOptional": true, - "defaultValue": "'transparent'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "blockSize", - "value": "MaybeResponsive", - "description": "Adjust the block size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "border", - "value": "BorderShorthand", - "description": "Set the border via the shorthand property.\n\nThis can be a size, optionally followed by a color, optionally followed by a style.\n\nIf the color is not specified, it will be `base`.\n\nIf the style is not specified, it will be `auto`.\n\nValues can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "MaybeAllValuesShorthandProperty>", - "description": "Set the radius of the border.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `start-start start-end end-end end-start`\n- 3 values: `start-start (start-end & end-start) start-end`\n- 2 values: `(start-start & end-end) (start-end & end-start)`\n\nFor example:\n- `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.\n- `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.\n- `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.\n- `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "borderStyle", - "value": "MaybeAllValuesShorthandProperty | \"\"", - "description": "Set the style of the border.\n\nIf set, it takes precedence over the `border` property's style.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "borderWidth", - "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Set the width of the border.\n\nIf set, it takes precedence over the `border` property's width.\n\nLike CSS, up to 4 values can be specified.\n\nIf one value is specified, it applies to all sides.\n\nIf two values are specified, they apply to the block sides and inline sides respectively.\n\nIf three values are specified, they apply to the block-start, both inline sides, and block-end respectively.\n\nIf four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "columnGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "direction", - "value": "MaybeResponsive<\"block\" | \"inline\">", - "description": "Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", - "isOptional": true, - "defaultValue": "'block'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "gap", - "value": "MaybeResponsive>", - "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "MaybeResponsive", - "description": "Adjust the inline size.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "justifyContent", - "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", - "isOptional": true, - "defaultValue": "'normal'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "maxBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum block size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "maxInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the maximum inline size.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "minBlockSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum block size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "minInlineSize", - "value": "MaybeResponsive", - "description": "Adjust the minimum inline size.", - "isOptional": true, - "defaultValue": "'0'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "overflow", - "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "MaybeResponsive>", - "description": "Adjust the padding of all edges.\n\n[1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 4 values: `block-start inline-end block-end inline-start`\n- 3 values: `block-start inline block-end`\n- 2 values: `block inline`\n\nFor example:\n- `large` means block-start, inline-end, block-end and inline-start paddings are `large`.\n- `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.\n- `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.\n- `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.\n\nA padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.", - "isOptional": true, - "defaultValue": "'none'" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlock", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the block-padding.\n\n- `large none` means block-start padding is `large`, block-end padding is `none`.\n\nThis overrides the block value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockEnd", - "value": "MaybeResponsive", - "description": "Adjust the block-end padding.\n\nThis overrides the block-end value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingBlockStart", - "value": "MaybeResponsive", - "description": "Adjust the block-start padding.\n\nThis overrides the block-start value of `paddingBlock`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInline", - "value": "MaybeResponsive | \"\">", - "description": "Adjust the inline padding.\n\n- `large none` means inline-start padding is `large`, inline-end padding is `none`.\n\nThis overrides the inline value of `padding`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineEnd", - "value": "MaybeResponsive", - "description": "Adjust the inline-end padding.\n\nThis overrides the inline-end value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "paddingInlineStart", - "value": "MaybeResponsive", - "description": "Adjust the inline-start padding.\n\nThis overrides the inline-start value of `paddingInline`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - }, - { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "PropertySignature", - "name": "rowGap", - "value": "MaybeResponsive", - "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", - "isOptional": true, - "defaultValue": "'' - meaning no override" - } - ], - "value": "export interface StackProps extends StackElementProps {\n}" - }, - "SizeUnitsOrAuto": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrAuto", - "value": "SizeUnits | \"auto\"", - "description": "" - }, - "SizeUnits": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnits", - "value": "`${number}px` | `${number}%` | `0`", - "description": "" - }, - "BorderShorthand": { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderShorthand", - "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "" - }, - "ReducedBorderSizeKeyword": { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedBorderSizeKeyword", - "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", - "description": "" - }, - "ReducedColorKeyword": { - "filePath": "src/surfaces/checkout/components/Stack.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedColorKeyword", - "value": "'base'", - "description": "" - }, - "BorderStyleKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "BorderStyleKeyword", - "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", - "description": "" - }, - "MaybeAllValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeAllValuesShorthandProperty", - "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", - "description": "" - }, - "SpacingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - }, - "SizeKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeKeyword", - "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", - "description": "" - }, - "MaybeTwoValuesShorthandProperty": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeTwoValuesShorthandProperty", - "value": "T | `${T} ${T}`", - "description": "" - }, - "SizeUnitsOrNone": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "SizeUnitsOrNone", - "value": "SizeUnits | \"none\"", - "description": "" - }, - "PaddingKeyword": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PaddingKeyword", - "value": "SizeKeyword | \"none\"", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "stack-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-stack direction=\"inline\" gap=\"base\">\n <s-image\n src=\"https://cdn.shopify.com/plant-1\"\n alt=\"Areca palm in a gray pot\"\n inlineSize=\"auto\"\n />\n <s-image\n src=\"https://cdn.shopify.com/plant-2\"\n alt=\"Fiddle leaf fig in a gray pot\"\n inlineSize=\"auto\"\n />\n <s-image\n src=\"https://cdn.shopify.com/plant-3\"\n alt=\"Snake plant in a gray pot\"\n inlineSize=\"auto\"\n />\n <s-image\n src=\"https://cdn.shopify.com/plant-4\"\n alt=\"Monstera deliciosa in a gray pot\"\n inlineSize=\"auto\"\n />\n</s-stack>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "title": "Useful for", - "type": "Generic", - "anchorLink": "useful-for", - "sectionContent": "\n- Placing items in rows or columns when sections don't work for your layout.\n- Controlling the spacing between elements." - }, - { - "title": "Considerations", - "type": "Generic", - "anchorLink": "considerations", - "sectionContent": "\n- Stack doesn't add any padding by default. If you want padding around your stacked elements, use `base` to apply the default padding.\n- When spacing becomes limited, Stack will always wrap children to a new line." - }, - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use smaller gaps between small elements and larger gaps between big ones.\n- Maintain consistent spacing in stacks across all pages of your app." - } - ] - }, - { - "name": "Switch", - "description": "The switch component provides a clear way for users to toggle options or settings on and off. Use switch for binary controls that take effect immediately, like enabling features, activating settings, or controlling visibility.\n\nSwitches provide instant visual feedback and are ideal for settings that don't require a save action to apply changes. For selections that require explicit submission, use [checkbox](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/checkbox) instead.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "switch-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "SwitchElementProps", - "typeDefinitions": { - "SwitchElementProps": { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "name": "SwitchElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface SwitchElementProps extends Pick {\n command?: Extract;\n}" - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "SwitchElementEvents", - "typeDefinitions": { - "SwitchElementEvents": { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "name": "SwitchElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface SwitchElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/Switch.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "switch-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-switch label=\"Shipping insurance\"></s-switch>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Text", - "description": "The text component displays inline text with specific visual styles or tones. Use text to emphasize or differentiate words or phrases within paragraphs or other block-level components, applying weight, color, or semantic styling.\n\nText supports multiple visual variants, alignment options, and line clamping for flexible inline typography control. For block-level text content, use [paragraph](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/paragraph).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "text-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "TextElementProps", - "typeDefinitions": { - "TextElementProps": { - "filePath": "src/surfaces/checkout/components/Text.ts", - "name": "TextElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityVisibility", - "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "display", - "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Text.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", - "isOptional": true, - "defaultValue": "'generic'" - } - ], - "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n type?: Extract;\n}" - }, - "MaybeResponsive": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeResponsive", - "value": "T | `@container${string}`", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "text-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-text type=\"small\" color=\"subdued\">\n All transactions are secure and encrypted.\n</s-text>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "title": "Useful for", - "type": "Generic", - "anchorLink": "useful-for", - "sectionContent": "\n- Adding inline text elements such as labels or line errors.\n- Applying different visual tones and text styles to specific words or phrases within a `s-paragraph`, such as a `strong` type or `critical` tone." - }, - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use plain and clear terms.\n- Don’t use jargon or technical language.\n- Don’t use different terms to describe the same thing.\n- Don’t duplicate content." - } - ] - }, - { - "name": "Text area", - "description": "The text area component captures multi-line text input. Use it to collect descriptions, notes, comments, or other extended text content.\n\nThe component supports configurable height, character limits, and validation. For single-line text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "text-area-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "TextAreaElementProps", - "typeDefinitions": { - "TextAreaElementProps": { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "name": "TextAreaElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "rows", - "value": "number", - "description": "A number of visible text lines.", - "isOptional": true, - "defaultValue": "2" - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface TextAreaElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "TextAreaElementEvents", - "typeDefinitions": { - "TextAreaElementEvents": { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "name": "TextAreaElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface TextAreaElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/TextArea.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - } - ], - "defaultExample": { - "image": "text-area-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-text-area\n label=\"Gift message\"\n value=\"Hope you enjoy this gift!\"\n rows={3}\n></s-text-area>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Text field", - "description": "The text field component captures single-line text input. Use it to collect short, free-form information like names, titles, or identifiers.\n\nThe component supports various input configurations including placeholders, character limits, and validation. For multi-line text entry, use [text area](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-area). For specialized input types, use [email field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/email-field), [URL field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/url-field), [password field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/password-field), or [search field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/search-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "text-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "TextFieldElementProps", - "typeDefinitions": { - "TextFieldElementProps": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | 'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "The type of icon to be displayed in the field.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface TextFieldElementProps extends Pick {\n icon?: IconProps['type'];\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "TextFieldElementEvents", - "typeDefinitions": { - "TextFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface TextFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "TextFieldElementSlots", - "typeDefinitions": { - "TextFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface TextFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "text-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-text-field\n label=\"First name (optional)\"\n defaultValue=\"Taylor\"\n></s-text-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Clearly label text fields so that it’s obvious what customers should enter.\n- Label text fields as optional when input isn’t required. For example, use the label First name (optional).\n- Don’t have optional fields pass true to the required property." - } - ] - }, - { - "name": "Time", - "description": "Represents a specific point or duration in time. Use to display dates, times, or durations clearly and consistently. May include a machine-readable `datetime` attribute for improved accessibility and functionality.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "time-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "TimeElementProps", - "typeDefinitions": { - "TimeElementProps": { - "filePath": "src/surfaces/checkout/components/Time.ts", - "name": "TimeElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Time.ts", - "syntaxKind": "PropertySignature", - "name": "dateTime", - "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Time.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface TimeElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "time-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-time dateTime=\"2023-10-15\">October 15, 2023</s-time>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "- Use Time component for displaying time values to ensure consistent formatting.\n\n- Provide time values in a clear, readable format.\n\n- Consider using 24-hour format for international audiences.\n\n- Include timezone information when relevant.\n\n- Use Time component for any time-related content to maintain semantic meaning." - } - ] - }, - { - "name": "Tooltip", - "description": "The tooltip component displays helpful information in a small overlay when users hover over or focus on an element. Use tooltip to provide additional context, explain functionality, or clarify terms without cluttering the interface with permanent text.\n\nTooltips support keyboard accessibility, positioning options, and activation on both hover and focus for inclusive interaction patterns.", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "tooltip-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Typography and content", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "TooltipElementProps", - "typeDefinitions": { - "TooltipElementProps": { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "name": "TooltipElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface TooltipElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "tooltip-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-stack direction=\"inline\" gap=\"small-400\" alignItems=\"center\">\n <s-text color=\"subdued\">2600 Portland Street SE</s-text>\n <s-clickable interestFor=\"curbside-pickup-1\">\n <s-icon type=\"info-filled\" />\n </s-clickable>\n <s-tooltip id=\"curbside-pickup-1\">\n Curbside pickup is at the back of the warehouse.\n </s-tooltip>\n</s-stack>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - }, - { - "name": "Unordered list", - "description": "The unordered list component displays a bulleted list of related items where sequence isn't critical. Use unordered list to present collections of features, options, requirements, or any group of items where order doesn't affect meaning.\n\nUnordered lists automatically add bullet points and support nested lists for hierarchical content organization. For sequential items where order is important, use [ordered list](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/ordered-list).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "unordered-list-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Layout and structure", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "UnorderedListElementProps", - "typeDefinitions": { - "UnorderedListElementProps": { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "name": "UnorderedListElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface UnorderedListElementProps extends UnorderedListProps$1 {\n}" - } - } - }, - { - "title": "List item", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", - "type": "ListItemElementProps", - "typeDefinitions": { - "ListItemElementProps": { - "filePath": "src/surfaces/checkout/components/ListItem.ts", - "name": "ListItemElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/ListItem.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface ListItemElementProps extends Pick {\n}" - } - } - } - ], - "defaultExample": { - "image": "unordered-list-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-unordered-list>\n <s-list-item>Free shipping on orders over $50</s-list-item>\n <s-list-item>30-day money-back guarantee</s-list-item>\n <s-list-item>Secure payment processing</s-list-item>\n</s-unordered-list>\n", - "language": "html" - } - ] - } - }, - "subSections": [ - { - "type": "Generic", - "anchorLink": "best-practices", - "title": "Best Practices", - "sectionContent": "\n- Use `s-unordered-list` when you need to present a list of related items or options.\n- Each item in the list should be wrapped in a `s-list-item` component.\n- Keep list items concise and consistent in length when possible.\n- Use `s-unordered-list` for navigation menus, feature lists, or any collection of related items.\n- Consider using `s-unordered-list` when you want to present information in a clear, scannable format." - } - ] - }, - { - "name": "URL field", - "description": "The URL field component collects URLs from users with built-in formatting and validation. Use URL field for website addresses, link destinations, or any URL input to provide URL-specific keyboard layouts and automatic validation.\n\nURL fields support protocol prefixing, validation, and help text to guide users toward entering properly formatted web addresses. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", - "category": "Polaris web components", - "related": [], - "isVisualComponent": true, - "thumbnail": "url-field-thumbnail.png", - "requires": "", - "type": "", - "subCategory": "Forms", - "definitions": [ - { - "title": "Properties", - "description": "", - "type": "URLFieldElementProps", - "typeDefinitions": { - "URLFieldElementProps": { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "name": "URLFieldElementProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface URLFieldElementProps extends Pick {\n}" - }, - "AutocompleteSection": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteSection", - "value": "`section-${string}`", - "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." - }, - "AutocompleteGroup": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AutocompleteGroup", - "value": "\"shipping\" | \"billing\"", - "description": "The contact information group the autocomplete data should be sourced from." - } - } - }, - { - "title": "Events", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", - "type": "URLFieldElementEvents", - "typeDefinitions": { - "URLFieldElementEvents": { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "name": "URLFieldElementEvents", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface URLFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - }, - "CallbackEventListener": { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "" - }, - "CallbackEvent": { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "" - } - } - }, - { - "title": "Slots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", - "type": "URLFieldElementSlots", - "typeDefinitions": { - "URLFieldElementSlots": { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "name": "URLFieldElementSlots", - "description": "", - "members": [ - { - "filePath": "src/surfaces/checkout/components/UrlField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface URLFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - } - } - ], - "defaultExample": { - "image": "url-field-default.png", - "codeblock": { - "title": "Code", - "tabs": [ - { - "code": "<s-url-field label=\"Website\" defaultValue=\"https://shopify.com\"></s-url-field>\n", - "language": "html" - } - ] - } - }, - "subSections": [] - } -] \ No newline at end of file diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json deleted file mode 100644 index 0146507984..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_static_pages.json +++ /dev/null @@ -1,1511 +0,0 @@ -[ - { - "title": "Configuration", - "description": "\nWhen you create a [checkout UI extension](/api/checkout-ui-extensions/), an [app extension configuration](/docs/apps/app-extensions/configuration) `shopify.extension.toml` file is automatically generated in your extension's directory.\n\nThis guide describes [extension targeting](#targets), [capabilities](#capabilities), [metafields](#metafields), and the [settings](#settings-definition) you can configure in the app extension configuration.\n", - "id": "configuration", - "sections": [ - { - "type": "Generic", - "anchorLink": "how-it-works", - "title": "How it works", - "sectionContent": "\nYou define properties for your checkout UI extension in the extension configuration file. The `shopify.extension.toml` file contains the extension's configuration, which includes the extension name, targets, metafields, capabilities, and settings.\n\nWhen an extension is published to Shopify, the contents of the settings file are pushed alongside the extension.\n", - "codeblock": { - "title": "shopify.extension.toml", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "api_version =\"2026-04\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Checkout.jsx\"\n\n[extensions.capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n\n[extensions.capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-key\"\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-other-key\"\n\n[extensions.settings]\n[[extensions.settings.fields]]\nkey = \"field_key\"\ntype = \"boolean\"\nname = \"field-name\"\n[[extensions.settings.fields]]\nkey = \"field_key_2\"\ntype = \"number_integer\"\nname = \"field-name-2\"\n", - "language": "toml" - } - ] - }, - "sectionNotice": [ - { - "title": "Tip", - "sectionContent": "\nYou can configure more than one type of extension within a configuration file.\n", - "type": "info" - } - ], - "sectionCard": [ - { - "name": "App extension configuration", - "subtitle": "Learn more", - "url": "/docs/apps/app-extensions/configuration", - "type": "gear" - } - ] - }, - { - "type": "GenericAccordion", - "anchorLink": "targets", - "title": "Targets", - "sectionContent": "\n[Targets](/docs/api/checkout-ui-extensions/extension-targets-overview) represent where your checkout UI extension will be injected. You may have one or many targets defined in your app extension configuration using the `targeting` field.\n\nAlong with the `target`, Shopify needs to know which code to execute for it. You specify the path to your code file by using the `module` property.\n\n\n ", - "accordionContent": [ - { - "title": "Supporting a single extension target", - "description": "\n Your code should have a default export if it only supports a single extension target.\n ", - "codeblock": { - "title": "Single extension target", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Block.jsx\"\n\n# ...\n", - "language": "toml" - } - ] - } - }, - { - "title": "Supporting multiple extension targets", - "description": "\n You can support multiple extension targets within a single configuration file. However, you must provide a separate file per extension target using the `export default` declaration.\n ", - "codeblock": { - "title": "Multiple extension targets", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.actions.render-before\"\nmodule = \"./Actions.jsx\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.shipping-option-item.render-after\"\nmodule = \"./ShippingOptions.jsx\"\n\n# ...\n", - "language": "toml" - } - ] - } - } - ] - }, - { - "type": "Generic", - "anchorLink": "capabilities", - "title": "Capabilities", - "sectionContent": "\nDefines the [capabilities](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-extension) associated with your extension.\n| Property | Description |\n|---|---|\n| [`api_access`](#api-access) | Allows your extension to query the Storefront API.\n| [`network_access`](#network-access) | Allows your extension make external network calls.\n| [`block_progress`](#block-progress) | States that your extension might block the buyer's progress.\n| [`collect_buyer_consent`](#collect-buyer-consent) | Allows your extension to collect buyer consent for specific policies such as SMS marketing.\n", - "codeblock": { - "title": "Capabilities", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[extensions.capabilities]\napi_access = true\nnetwork_access = true\nblock_progress = true\n\n[extensions.capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n# ...\n\n", - "language": "toml" - } - ] - } - }, - { - "type": "Generic", - "anchorLink": "api-access", - "title": "Storefront API access", - "sectionContent": "The following section describes the use cases of the `api_access` capability and the [Storefront API](/api/storefront) access scopes.", - "codeblock": { - "title": "Enable Storefront API access", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[extensions.capabilities]\napi_access = true\n\n# ...\n", - "language": "toml" - } - ] - }, - "sectionCard": [ - { - "name": "API access examples", - "subtitle": "See", - "url": "/docs/api/checkout-ui-extensions/apis/storefront-api#examples", - "type": "blocks" - } - ], - "sectionSubContent": [ - { - "title": "When to use Storefront API access", - "sectionContent": "API access is used when your extension needs to retrieve data from the [Storefront API](/api/storefront). For example, you may need to [fetch product data](/apps/checkout/product-offers/add-product-offer), check the product tags on an item in the cart, or convert a product's price to another currency.\n\n> Tip:\n> Shopify handles the authentication for all API calls from an extension.\n" - }, - { - "title": "Methods for accessing the Storefront API", - "sectionContent": "Enabling the `api_access` capability allows you to use the Standard API [`query`](/docs/api/checkout-ui-extensions/apis/storefront-api) method and the global `fetch` to retrieve data from the [Storefront API](/api/storefront) without manually managing token aquisition and refresh.\n\n`query` lets you request a single GraphQL response from the Storefront API.\n\nIf you prefer to construct GraphQL requests yourself or you would like to use a full-featured GraphQL client such as Apollo or urql, our custom `fetch` global automatically appends the required access tokens.\n\nThe GraphQL client of your choice shouldn’t use any DOM APIs, as they aren’t available in a checkout UI extension's Web Worker.\n\n> Note: Both `query` and `fetch` will work for calling the Storefront API with the `api_access` capability enabled. If you are using `fetch` to get data external to Shopify, refer to the [`network_access`](/api/checkout-ui-extensions/configuration#network-access) capability." - }, - { - "title": "Storefront API access scopes", - "sectionContent": "\nYour extensions will have the following unauthenticated access scopes to the Storefront API:\n\n- unauthenticated_read_product_publications\n- unauthenticated_read_collection_publications\n- unauthenticated_read_product_listings\n- unauthenticated_read_product_tags\n- unauthenticated_read_selling_plans\n- unauthenticated_read_collection_listings\n- unauthenticated_read_metaobjects\n" - }, - { - "title": "Protocol Links", - "sectionContent": "\nProtocol links are an easy way for Shopify to infer the type of request you are trying to make. If you would like to make a request to the [Storefront GraphQL API](/docs/api/storefront), you can use our [Storefront Protocol](/docs/api/checkout-ui-extensions/latest/apis/storefront-api#examples) to infer your Storefront URL and API version.\n " - } - ] - }, - { - "type": "Generic", - "anchorLink": "network-access", - "title": "Network access", - "sectionContent": "\nThe following section describes use cases for requesting network access, alternatives to requesting network access, and steps for completing a request for network access.\n> Caution:\n> If your extension specifies the `network_access` capability, you must request access in order to publish your extension.\n", - "codeblock": { - "title": "Enable network access", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[extensions.capabilities]\nnetwork_access = true\n\n# ...\n", - "language": "toml" - } - ] - }, - "sectionSubContent": [ - { - "title": "When to request network access", - "sectionContent": "If you need to get data into checkout that you can't currently get from Shopify, then you should request network access. For example, you might need to fetch additional data to render loyalty points." - }, - { - "title": "Alternatives to network access", - "sectionContent": "\nInstead of fetching data with an external network call, consider retrieving the data from a metafield. Your app may be able to use the [Admin API](/docs/api/admin) to write [metafields](/api/admin-graphql/latest/objects/metafield) on the shop, product, or customer ahead of checkout.\n\nRetrieving data from [metafields](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-appmetafields) during checkout is faster since it won't introduce an external network call. This allows you to rely on Shopify for the uptime, scaling, and durability of the data storage.\n" - }, - { - "title": "Complete a request for network access", - "sectionContent": "\n1. Go to your [Partner Dashboard](https://partners.shopify.com/current/apps).\n2. Click the name of the app that you want to change.\n3. Click **API access**.\n4. Under **Allow network access in checkout UI extensions**, click **Allow network access**\n\n Your request is automatically approved and your app is immediately granted the approval scope that's required for your checkout UI extension to make external network calls.\n\n5. Add network_access = true to the [extensions.capabilities] section of your extension's configuration file." - }, - { - "title": "Required CORS headers", - "sectionContent": "\nUI extensions run in a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) but the exact origin they run on may change without notice. When receiving network requests from extensions, your server must support [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for any origin by always returning this response header:\n\nAccess-Control-Allow-Origin: *\n" - }, - { - "title": "Security considerations", - "sectionContent": "\nWhen processing HTTP requests on your API server, you cannot guarantee that your own extension will have made every request. When responding with sensitive data, keep in mind that requests could originate from anywhere on the Internet.\n\nYour extension can pass a [session token](/docs/api/checkout-ui-extensions/latest/apis/session-token) to your API server but this only guarantees the integrity of its claims. It does not guarantee the request itself originated from Shopify. For example, your API server could trust the session token's `sub` claim (the customer ID) but it could not trust a `?customer_id=` query parameter.\n\nConsider a scenario where your extension retrieves a discount code from your API server and [applies it to the checkout](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-applydiscountcodechange). It would not be safe to expose an API endpoint named `/get-discount-code` if any buyer could make a direct HTTP request and obtain a discount code.\n" - }, - { - "title": "App Proxy", - "sectionContent": "\nUI extensions can make fetch requests to [App Proxy](/docs/apps/online-store/app-proxies) URLs, but there are some differences and limitations related to the security context within which UI extensions run.\n\nUI extension requests made to the App Proxy will execute as CORS requests. See _Required CORS headers_ above for information about requirements related to CORS.\n\nUI extension requests made to the App Proxy will not assign the logged_in_customer_id query parameter. Instead use a [session token](/docs/api/checkout-ui-extensions/latest/apis/session-token) which provides the sub claim for the logged in customer.\n\nUI extension requests made to the App Proxy of password protected shops is not supported. Extension requests come from a web worker which does not share the same session as the parent window.\n\nThe App Proxy doesn't handle all [HTTP request methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). Specifically, CONNECT and TRACE are unsupported.\n" - } - ] - }, - { - "type": "Generic", - "anchorLink": "block-progress", - "title": "Block progress", - "sectionContent": "The following section describes blocking the buyer's progress through checkout, and how you can detect whether the merchant has allowed it.", - "sectionCard": [ - { - "name": "Blocking examples", - "subtitle": "See", - "url": "/docs/api/checkout-ui-extensions/apis/buyer-journey#examples", - "type": "blocks" - } - ], - "codeblock": { - "title": "Enable progress blocking", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[extensions.capabilities]\nblock_progress = true\n\n# ...\n\n", - "language": "toml" - } - ] - }, - "sectionSubContent": [ - { - "title": "When to request blocking progress", - "sectionContent": "\nIf your extension relies on specific input then you might need to block the buyer's progress until they've provided all required information. You can do this with a [buyer journey](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-buyerjourney) intercept, by returning `behavior: 'block'`.\n\nFor example, for some purchases you need to collect and verify a customer's age. For the order to be valid, you need to verify that an age is set and that it's greater than or equal to a minimum value.\n\nIn order to block checkout progress, your extension must have the `block_progress` capability.\n" - }, - { - "title": "Granting the capability to block progress", - "sectionContent": "\nSetting `block_progress` in the `shopify.extension.toml` file informs merchants that your extension blocks the buyer's progress for invalid orders. Merchants can allow or disallow this capability in the checkout editor.\n\n> Note:\n> When running a local extension with the `block_progress` capability, it will be automatically granted. This simulates a scenario where the merchant has allowed the capability.\n" - }, - { - "title": "Detecting the ability to block progress", - "sectionContent": "\nIn your extension, look for `block_progress` in [extension.capabilities](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-extension) to see if the merchant has granted the blocking capability.\n\nIf the merchant declined the permission for your app to block progress, the `behavior: 'block'` option in the [buyer journey](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-buyerjourney) intercept will be treated as `behavior: 'allow'`, and checkout will proceed as normal.\n\nWhen developing a local extension, you can remove the `block_progress` capability from your `shopify.extension.toml` file to simulate a merchant disallowing the capability.\n\n> Tip:\n> We recommend having some UI to cover cases where you can't block checkout progress. For example, you might want to show a warning rather than block checkout progress when an order doesn't pass validation." - } - ] - }, - { - "type": "Generic", - "anchorLink": "collect-buyer-consent", - "title": "Collect buyer consent", - "sectionContent": "If your extension utilizes the [ConsentCheckbox](/docs/api/checkout-ui-extensions/components/forms/consentcheckbox) or [ConsentPhoneField](/docs/api/checkout-ui-extensions/components/forms/consentphonefield) components to render a customized UI for collecting buyer consent, you must first declare that capability in your configuration file.", - "sectionSubContent": [ - { - "title": "SMS Marketing", - "sectionContent": "In order to collect buyer consent for SMS marketing, you'll need to specifically declare this intent using `sms_marketing = true` in your toml configuration. This corresponds to the `policy` prop for the `Consent` components." - }, - { - "title": "Customer Privacy", - "sectionContent": "In order to collect customer privacy consent, you'll need to add `customer_privacy = true` in your toml configuration. This will let you use our [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/apis/customer-privacy)." - } - ], - "codeblock": { - "title": "Collect buyer consent", - "tabs": [ - { - "title": "shopify.extension.toml", - "code": "# ...\n\n[extensions.capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n# ...\n\n", - "language": "toml" - } - ] - } - }, - { - "type": "Generic", - "anchorLink": "metafields", - "title": "Metafields", - "sectionContent": "\nDefines the [metafields](/docs/apps/custom-data/metafields) that are available to your extension. You retrieve these metafields in your extension by reading [`appMetafields`](/docs/api/checkout-ui-extensions/latest/apis/metafields#standardapi-propertydetail-appmetafields).\n\nDefine the metafields your extension needs using `[[extensions.metafields]]` and `[[extensions.targeting.metafields]]`.\n\nYou can use `[[extensions.metafields]]` for metafields that your extension always needs, while you can use `[[extensions.targeting.metafields]]` if you only want to fetch metafields when your extension is placed in a specific extension target.\n\n> Tip:\n> You may write to `cart` metafields by using [`applyMetafieldsChange`](/docs/api/checkout-ui-extensions/apis/checkoutapi#properties-propertydetail-applymetafieldchange) with `type: \"updateCartMetafield\"`.\n ", - "sectionSubContent": [ - { - "title": "App owned metafields", - "sectionContent": "\n[App owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) are supported. You can use app owned metafields when your app needs to control the data and visibility of the metafield.\n\nYour extension can access app owned metafields that are requested in its toml using the `$app` format. Your extension can only access app owned metafields that belong to its parent app.\n\n> Caution:\n> When accessing app owned metafields, you must use the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported.\n ", - "sectionCard": [ - { - "name": "App owned metafields", - "subtitle": "Learn more", - "url": "/docs/apps/build/custom-data/ownership#reserved-prefixes", - "type": "tutorial" - } - ] - }, - { - "title": "Supported resource metafield types", - "sectionContent": "\nSupported resource metafield types include:\n\n| Resource | Description |\n|---| --- |\n| `cart` | The cart associated with the current checkout. |\n| `company` | The company for B2B checkouts. |\n| `companyLocation` | The company's location for B2B checkouts. |\n| `customer` | The customer account that is interacting with the current checkout. |\n| `product` | The products that the customer intends to purchase. |\n| `shop` | The shop that is associated with the current checkout. |\n| `shopUser` | The Shop App user that is associated with the current checkout if there is one. |\n| `variant` | The product variants that the customer intends to purchase. |\n\nOther resource metafield types outside of the above list are not supported.\n " - } - ], - "codeblock": { - "title": "Metafields", - "tabs": [ - { - "title": "Metafields", - "code": "# ...\n\n# The metafields for the extension\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-key-1\"\n\n[[extensions.metafields]]\nnamespace = \"my-namespace\"\nkey = \"my-key-2\"\n\n# app owned metafield\n[[extensions.metafields]]\nnamespace = \"$app:my-app-owned-namespace\"\nkey = \"my-key-3\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.actions.render-before\"\nmodule = \"./Actions.jsx\"\n\n # For the above target, use these metafields\n [[extensions.targeting.metafields]]\n namespace = \"my-namespace\"\n key = \"my-target-key\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.shipping-option-item.render-after\"\nmodule = \"./ShippingOptions.jsx\"\n\n\n", - "language": "toml" - } - ] - }, - "sectionCard": [ - { - "name": "useAppMetafields", - "subtitle": "Hook", - "url": "/docs/api/checkout-ui-extensions/react-hooks/metafields/useappmetafields", - "type": "blocks" - }, - { - "name": "useApplyMetafieldsChange", - "subtitle": "Hook", - "url": "/docs/api/checkout-ui-extensions/react-hooks/metafields/useapplymetafieldschange", - "type": "blocks" - } - ] - }, - { - "type": "Markdown", - "anchorLink": "settings-definition", - "title": "Settings definition", - "sectionContent": "The settings for a checkout UI extension define a set of fields that the merchant can set a value for from the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). You can use validation options to apply additional constraints to the data that the setting can store, such as a minimum or maximum value. \n\n Each settings definition can include up to 20 settings. \n\n > Note: \n > All setting inputs are optional. You should code the extension so that it still works if the merchant hasn't set a value for the setting.", - "sectionSubContent": [ - { - "title": "Properties", - "sectionContent": "The following table describes the properties that you can use to define a setting:\n\n | Property | Required? | Description | Example |\n|---|---|---|---|\n| `key` | Yes | The key of the setting. When a merchant configures a value for this setting, the value will be exposed under this `key` when running your extension | 
\"banner_title\"
|\n| `type` | Yes | The [type](#supported-setting-types) of setting. | 
\"single_line_text_field\"
|\n| `name` | Yes | The name of the setting. `name` is displayed to the merchant in the checkout editor. | 
\"Banner title\"
|\n| `description` | No | The description of the setting. `description` is displayed to the merchant in the checkout editor. | 
\"Enter a title for the banner.\"
|\n| `validations` | No | Constraints on the setting input that Shopify validates. | 
validations: 
 name = \"max\",
 value = \"25\"
|" - }, - { - "title": "Supported setting types", - "sectionContent": "The setting type determines the type of information that the setting can store. The setting types have built-in validation on the setting input. \n\n Settings can have the following types: \n\n| Type | Description | Example value |\n|---|---|---|\n| `boolean` | A true or false value. | 
true
|\n| `date` | A date in ISO 8601 format without a presumed time zone. | 
2022-02-02
|\n| `date_time` | A date and time in ISO 8601 format without a presumed time zone. | 
2022-01-01T12:30:00
|\n| `single_line_text_field` | A single line string. | 
Canada
|\n| `multi_line_text_field` | A multi-line string. | 
Canada
United States
Brazil
Australia
|\n| `number_integer` | A whole number in the range of +/-9,007,199,254,740,991. | 
10
|\n| `number_decimal` | A number with decimal places in the range of +/-9,999,999,999,999.999999999. | 
10.4
|\n| `variant_reference` | A globally-unique identifier (GID) for a product variant. | 
gid://shopify/ProductVariant/1
 |"
-          },
-          {
-            "title": "Validation options",
-            "sectionContent": "Each setting can include validation options. Validation options enable you to apply additional constraints to the data that a setting can store, such as a minimum or maximum value, or a regular expression. The setting's `type` determines the available validation options. \n\n You can include a validation option for a setting using the validation `name` and a corresponding `value`. The appropriate value depends on the setting type to which the validation applies.\n\n The following table outlines the available validation options with supported types for applying constraints to a setting:\n\n | Validation option | Description | Supported types | Example |\n|---|---|---|---|\n| Minimum length | The minimum length of a text value. | 
  • single_line_text_field
  • multi_line_text_field
 | 
[[extensions.settings.fields.validations]]
 name = \"min\"
 value = \"8\"
 |\n| Maximum length | The maximum length of a text value. | 
  • single_line_text_field
  • multi_line_text_field
 | 
[[extensions.settings.fields.validations]]
 name = \"max\"
 value = \"25\"
 |\n| Regular expression | A regular expression. Shopify supports [RE2](https://github.com/google/re2/wiki/Syntax). | 
  • single_line_text_field
  • multi_line_text_field
 | 
[[extensions.settings.fields.validations]]
 name = \"regex\"
 value = \"(@)(.+)$\"
 |\n| Choices | A list of up to 128 predefined options that limits the values allowed for the metafield.  | `single_line_text_field` | 
[[extensions.settings.fields.validations]]
 name = \"choices\"
 value = \"[\\\\\"red\\\\\", \\\\\"green\\\\\", \\\\\"blue\\\\\"]\"
 |\n| Minimum date | The minimum date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date` | 
[[extensions.settings.fields.validations]]
 name = \"min\"
 value = \"2022-01-01\"
 |\n| Maximum date | The maximum date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date` | 
[[extensions.settings.fields.validations]]
 name = \"max\"
 value = \"2022-03-03\"
 |\n| Minimum datetime | The minimum date and time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date_time` | 
[[extensions.settings.fields.validations]]
 name = \"min\"
 value = \"2022-03-03T16:30:00\"
 |\n| Maximum datetime | The maximum date and time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. |  `date_time` | 
[[extensions.settings.fields.validations]]
 name = \"max\"
 value = \"2022-03-03T17:30:00\"
 |\n| Minimum integer | The minimum integer number. | `number_integer` | 
[[extensions.settings.fields.validations]]
 name = \"min\"
 value = \"9\"
 |\n| Maximum integer | The maximum integer number. | `number_integer` | 
[[extensions.settings.fields.validations]]
 name = \"max\"
 value = \"15\"
 |\n| Minimum decimal | The minimum decimal number. |  `number_decimal` | 
[[extensions.settings.fields.validations]]
 name = \"min\"
 value = \"0.5\"
 |\n| Maximum decimal | The maximum decimal number. |  `number_decimal` | 
[[extensions.settings.fields.validations]]
 name = \"max\"
 value = \"1.99\"
 |\n| Maximum precision | The maximum number of decimal places to store for a decimal number. | `number_decimal` | 
[[extensions.settings.fields.validations]]
 name = \"max_precision\"
 value = \"2\"
 |"
-          }
-        ]
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "example-settings-definition",
-        "title": "Example settings definition",
-        "sectionContent": "The following example shows a settings definition that defines a setting named `banner_title` of type `single_line_text_field`. When the merchant sets a value for this setting from the checkout editor, Shopify validates that the provided value is between 5 and 20 characters in length \n\n Learn more about the settings api by completing our [custom banners example](/apps/checkout/custom-banners/add-custom-banner).",
-        "sectionCard": [
-          {
-            "name": "Settings example code",
-            "subtitle": "See",
-            "url": "/docs/api/checkout-ui-extensions/apis/standardapi#example-settings",
-            "type": "blocks"
-          }
-        ],
-        "codeblock": {
-          "title": "Example settings",
-          "tabs": [
-            {
-              "title": "shopify.extension.toml",
-              "code": "api_version = \"2026-04\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"My checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[extensions.settings]\n\n[[extensions.settings.fields]]\nkey = \"banner_title\"\ntype = \"single_line_text_field\"\nname = \"Banner title\"\ndescription = \"Enter a title for the banner.\"\n\n[[extensions.settings.fields.validations]]\nname = \"min\"\nvalue = \"5\"\n[[extensions.settings.fields.validations]]\nname = \"max\"\nvalue = \"20\"\n",
-              "language": "toml"
-            }
-          ]
-        }
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "preloads-definition",
-        "title": "Preloads definition",
-        "sectionContent": "\nFor specific targets, you must provide the URL of assets or pages loaded by UI components within its extension. This allows Shopify to preload them as early as possible and ensure a performant experience for buyers. Currently, the only supported property is `chat` for the [`Chat` component](/docs/api/checkout-ui-extensions/latest/components/overlays/chat).\n\nThe `chat` property specifies the URL for the iframe used in this extension target. The URL can be absolute or relative. Relative URLs are resolved against the app URL defined in the app configuration.\n\nFor example,\n\n* if the app URL is `https://example.com` and `chat = \"/my-chat-application\"`, the resolved URL will be `https://example.com/my-chat-application`.\n* if `chat = \"https://my-chat-application.com\"`, the resolved URL will be `https://my-chat-application.com`.\n      ",
-        "codeblock": {
-          "title": "Extension target preloads",
-          "tabs": [
-            {
-              "title": "shopify.extension.toml",
-              "code": "# ...\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.chat.render\"\nmodule = \"./Block.jsx\"\n\n  [extensions.targeting.preloads]\n  chat = \"https://my-chat-application.com\"\n\n# ...\n",
-              "language": "toml"
-            }
-          ]
-        }
-      }
-    ]
-  },
-  {
-    "title": "Error handling",
-    "description": "You can use standard web techniques to handle errors in [checkout UI extensions](/api/checkout-ui-extensions/) but you may need to account for how they run inside of a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).",
-    "id": "error-handling",
-    "sections": [
-      {
-        "type": "Generic",
-        "anchorLink": "handling-any-error",
-        "title": "Handling any error",
-        "sectionContent": "Add an `unhandledrejection` listener for promise rejections or an `error` listener for other exceptions like Javascript runtime errors or failures to load a resource.",
-        "codeblock": {
-          "title": "Handling any error",
-          "tabs": [
-            {
-              "code": "// For unhandled promise rejections\nself.addEventListener(\n  'unhandledrejection',\n  (error) => {\n    console.warn(\n      'event unhandledrejection',\n      error,\n    );\n  },\n);\n\n// For other exceptions\nself.addEventListener('error', (error) => {\n  console.warn('event error', error);\n});\n",
-              "language": "ts"
-            }
-          ]
-        }
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "third-party-libraries",
-        "title": "Third party libraries",
-        "sectionContent": "\nYou can use error reporting libraries like [Sentry](https://sentry.io/). However, they might require extra configuration because UI extensions run inside of a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). You should also consider using [source maps](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#troubleshooting-with-source-maps) to help debug errors.\n\n> Tip:\n> You must request [network access](/api/checkout-ui-extensions/configuration#network-access) to transmit errors to a third party service.\n"
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "sentry",
-        "title": "Sentry",
-        "sectionContent": "\n      Install and initialize Sentry following their [Browser JavaScript guide](https://docs.sentry.io/platforms/javascript/). We recommend disabling the default integrations to be sure it will run within a Web Worker. You'll need to add event listeners manually.",
-        "codeblock": {
-          "title": "Sentry",
-          "tabs": [
-            {
-              "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport * as Sentry from '@sentry/browser';\n\nSentry.init({\n  dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0',\n  defaultIntegrations: false,\n});\n\nself.addEventListener(\n  'unhandledrejection',\n  (error) => {\n    Sentry.captureException(error);\n  },\n);\n\nself.addEventListener('error', (error) => {\n  Sentry.captureException(error);\n});\n\n// Your normal extension code.\nexport default function extension() {\n  render(<Extension />, document.body);\n}\n\nfunction Extension() {\n  return <s-banner>Your extension</s-banner>;\n}\n",
-              "language": "ts"
-            }
-          ]
-        }
-      }
-    ]
-  },
-  {
-    "title": "Targets Overview",
-    "description": "\nA [target](/docs/apps/app-extensions/configuration#targets) represents where your checkout UI extension will appear.\n\nYou register for targets in your [configuration file](/docs/api/checkout-ui-extensions/configuration), and you include a JavaScript function that will run at that location in checkout.\n  ",
-    "id": "extension-targets-overview",
-    "sections": [
-      {
-        "type": "GenericAccordion",
-        "title": "Checkout locations",
-        "anchorLink": "supported-locations",
-        "sectionContent": "Checkout is where buyers go to purchase goods. Checkout consists of the information, shipping, and payment steps in addition to the order summary and Shop Pay. Learn more about building [custom functionality for checkout](/docs/api/checkout-ui-extensions).",
-        "accordionContent": [
-          {
-            "title": "Information",
-            "description": "\nThis is the first step in the checkout process where the buyer enters contact information and a delivery address.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-information.png"
-          },
-          {
-            "title": "Shipping",
-            "description": "\nPoint in checkout where the buyer selects a shipping method.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-shipping.png"
-          },
-          {
-            "title": "Payment",
-            "description": "\nPoint in checkout where the buyer enters their payment information.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-payment.png"
-          },
-          {
-            "title": "Order summary",
-            "description": "\nSummary of the cart contents, discounts, and order totals.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-order-summary.png"
-          },
-          {
-            "title": "Shop Pay",
-            "description": "\nAccelerated checkout where Shopify pre-fills buyer information using their Shop Pay account.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-shop-pay.png"
-          },
-          {
-            "title": "Split shipping",
-            "description": "\nWhen multiple shipments are expected, a checkout will render split shipping options.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-split-shipping.png"
-          },
-          {
-            "title": "Local Pickup",
-            "description": "\nPoint in checkout where the buyer can select a store location to pick up their purchase.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-local-pickup.png"
-          },
-          {
-            "title": "Pickup Points",
-            "description": "\nPoint in checkout where the buyer can select a pickup point to have their purchase delivered to.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-pickup-points.png"
-          },
-          {
-            "title": "Overlays",
-            "description": "\nStatic extension targets that floats above the checkout.\n\nReview [all extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-chat.png"
-          },
-          {
-            "title": "One-page checkout",
-            "description": "\nAll checkout pages (information, shipping, and payment) are combined into a single page with the order summary.\n\nGet started testing extensions on [one-page checkout](/docs/apps/checkout/best-practices/testing-ui-extensions#one-page-checkout).\n",
-            "image": "supported-locations-one-page-checkout.png"
-          }
-        ]
-      },
-      {
-        "type": "GenericAccordion",
-        "title": "Thank you locations",
-        "anchorLink": "supported-typ-locations",
-        "sectionContent": "The **Thank you** page is shown to buyers immediately after a checkout is successfully submitted. Learn more about building for [the **Thank you** page](/docs/apps/checkout/thank-you-order-status).",
-        "accordionContent": [
-          {
-            "title": "Order details",
-            "description": "\nDisplays all order information to buyers.\n\nReview [all **Thank you** page extension targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-thank-you.png"
-          },
-          {
-            "title": "Order summary",
-            "description": "\nSummary of the cart contents, discounts, and order totals.\n\nReview [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-order-summary-thank-you.png"
-          },
-          {
-            "title": "Overlays",
-            "description": "\nStatic extension targets that floats above the Thank you page.\n\nReview [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensions/targets).\n",
-            "image": "supported-locations-chat-thank-you.png"
-          }
-        ]
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "static-extension-targets",
-        "title": "Static extension targets",
-        "image": "static-extension-targets.png",
-        "sectionContent": "Static extension targets render immediately before or after most core checkout features such as contact information, shipping methods, and order summary line items. Merchants use the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor) to activate and place the extension in the checkout experience.\n      \n\nWhen a core checkout feature isn't rendered, neither are the static extension targets tied to it. For example, shipping methods aren't shown when customers select the option for store pickup and the UI extensions that load before or after the shipping method aren't rendered.\n      \n\nChoose static extension targets when your content and functionality is closely related to a core checkout feature. An example is a shipping delay notice.\n      ",
-        "sectionCard": [
-          {
-            "name": "Extension targets",
-            "subtitle": "API reference",
-            "url": "/docs/api/checkout-ui-extensions/targets",
-            "type": "blocks"
-          }
-        ]
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "block-extension-targets",
-        "title": "Block extension targets",
-        "sectionContent": "Block extension targets render between core checkout features. Merchants can use the [checkout and accounts editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor) to place the extension in the [**checkout**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations), [**Thank you**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-typ-locations) pages.\n      \n\nBlock extensions are always rendered, regardless of what other checkout elements are present. For example, an extension placed above the shipping address will still render even for digital products which don't require a shipping address.\n\nChoose block extension targets when your content and functionality works independently of a core checkout feature. This is useful for custom content, like a field to capture order notes from the customer.\n      \n\nBlock extension targets always support multiple placements. Each placement has an associated placement reference that represents its location on the page. For example, the block extension target `purchase.checkout.block.render` supports fourteen placements. The placement references include `INFORMATION1`, `DELIVERY1`, `PAYMENT1`, and more.\n      \n\nYou can use placement references as URL parameters to [test block extensions](/docs/apps/build/checkout/test-checkout-ui-extensions#block-targets) in all supported placements on a page. You can also use placement references to [define the default placement](/docs/apps/build/app-extensions/configure-app-extensions#checkout-ui-extensions) of an extension for merchants.",
-        "image": "block-extension-targets.png",
-        "sectionCard": [
-          {
-            "name": "Extension targets",
-            "subtitle": "API reference",
-            "url": "/docs/api/checkout-ui-extensions/targets",
-            "type": "blocks"
-          },
-          {
-            "name": "Placement references",
-            "subtitle": "Learn more",
-            "url": "/docs/apps/build/checkout/test-checkout-ui-extensions#placement-references",
-            "type": "resource"
-          }
-        ]
-      }
-    ]
-  },
-  {
-    "title": "Checkout UI extensions",
-    "description": "Checkout UI extensions let app developers build custom functionality that merchants can install\n    at defined points in the checkout flow, including product information, shipping, payment,\n    order summary, and Shop Pay.\n    \n\n > Shopify Plus: \n>Checkout UI extensions for the information, shipping and payment step are available only to stores on a [Shopify Plus](https://www.shopify.com/plus) plan.",
-    "id": "checkout-ui-extensions",
-    "image": "/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui.png",
-    "darkImage": "/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui-dark.png",
-    "mobileImage": "/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui-mobile.png",
-    "mobileDarkImage": "/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui-mobile-dark.png",
-    "sections": [
-      {
-        "type": "Generic",
-        "anchorLink": "scaffolding-extension",
-        "title": "Scaffolding an extension",
-        "sectionContent": "Use the Shopify CLI to [generate a new extension](/docs/api/shopify-cli/app/app-generate-extension) in the directory of your app.\n\nMake sure you’re using Shopify CLI `v3.85.3` or higher. You can check your version by running `shopify version`.\n        ",
-        "codeblock": {
-          "title": "Shopify CLI",
-          "tabs": [
-            {
-              "code": "# create an app if you don't already have one:\nshopify app init --name my-app\n\n# navigate to your app's root directory:\ncd my-app\n\n# generate a new extension:\nshopify app generate extension\n\n# follow the steps to create a new\n# extension in ./extensions.",
-              "language": "bash"
-            }
-          ]
-        },
-        "initialLanguage": "bash"
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "eslint-configuration",
-        "title": "Optional ESLint configuration",
-        "sectionContent": "\nIf your app is using ESLint, update your configuration to include the new global `shopify` object.\n        ",
-        "codeblock": {
-          "title": ".eslintrc.cjs",
-          "tabs": [
-            {
-              "code": "module.exports = {\n  globals: {\n    shopify: 'readonly',\n  },\n};\n",
-              "language": "js"
-            }
-          ]
-        },
-        "initialLanguage": "js"
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "configuration-file",
-        "title": "Configuration file",
-        "sectionContent": "When you create a UI extension, the `shopify.extension.toml` file is generated in your extension directory. Use this file to configure your extension name, extension targets, metafields, capabilities, and settings definition.\n\nExtension targets provide locations where merchants can insert custom content. Static extension targets are tied to core checkout features like contact information, shipping methods, and order summary line items. Block targets can display at any point in the checkout process and will always render regardless of which checkout features are available. An example is a field to capture order notes from the customer.",
-        "sectionCard": [
-          {
-            "name": "Configuration guide",
-            "subtitle": "Learn more",
-            "url": "/docs/api/checkout-ui-extensions/configuration",
-            "type": "gear"
-          },
-          {
-            "name": "Extension targets",
-            "subtitle": "Overview",
-            "url": "/docs/api/checkout-ui-extensions/extension-targets-overview",
-            "type": "blocks"
-          }
-        ],
-        "codeblock": {
-          "title": "shopify.extension.toml",
-          "tabs": [
-            {
-              "code": "api_version = \"2026-04\"\n\n[[extensions]]\ntype = \"ui_extension\"\nname = \"Your checkout extension\"\nhandle = \"checkout-ui\"\nuid = \"fddfc370-27c7-c30f-4ee0-a927194e2accadefd40c\"\n\n[[extensions.targeting]]\ntarget = \"purchase.checkout.block.render\"\nmodule = \"./Extension.jsx\"\n",
-              "language": "toml"
-            }
-          ]
-        },
-        "initialLanguage": "yaml"
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "extension-functions",
-        "title": "Extension functions",
-        "sectionContent": "Checkout will execute the module’s default export so it can render a user interface.\n\nExtension UIs are powered by [Remote DOM](https://github.com/Shopify/remote-dom/), a fast and secure environment for custom [(non-DOM)](#security) UIs.",
-        "sectionCard": [],
-        "codeblock": {
-          "title": "Extension.jsx",
-          "tabs": [
-            {
-              "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default async () => {\n  render(<Extension />, document.body);\n};\n\nfunction Extension() {\n  return <s-banner>Your extension</s-banner>;\n}\n",
-              "language": "tsx"
-            }
-          ]
-        },
-        "initialLanguage": "tsx"
-      },
-      {
-        "type": "Generic",
-        "title": "Preact by default",
-        "sectionContent": "UI Extensions are scaffolded with [Preact](https://preactjs.com/) by default. This means you can use Preact patterns and principles within your extension.\n\nSince Preact is included as a standard dependency, you have access to all of its features including [hooks](https://preactjs.com/guide/v10/hooks/) like `useState` and `useEffect` for managing component state and side effects.\n\nYou can also use [Preact Signals](https://preactjs.com/guide/v10/signals/) for reactive state management, and take advantage of standard web APIs just like you would in a regular Preact application.\n        ",
-        "anchorLink": "preact-by-default",
-        "codeblock": {
-          "title": "Extension.jsx",
-          "tabs": [
-            {
-              "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\nimport {useState} from 'preact/hooks';\n\nexport default async () => {\n  render(<Extension />, document.body);\n};\n\nfunction Extension() {\n  const [count, setCount] = useState(0);\n\n  return (\n    <>\n      <s-text>Count: {count}</s-text>\n      <s-button\n        onClick={() => setCount(count + 1)}\n      >\n        Increment\n      </s-button>\n    </>\n  );\n}\n",
-              "language": "jsx"
-            }
-          ]
-        }
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "extension-apis",
-        "title": "Extension APIs",
-        "sectionContent": "The platform defines a global `shopify` object that contains all properties and methods available to UI extensions.\n\nThese APIs enable UI extensions to get information about the checkout or related objects and to perform actions. For example, you can retrieve what’s in customer carts and offer related products.\n\nAPIs with a `value` property are [Preact Signals](https://preactjs.com/guide/v10/signals/). Preact will automatically re-render your extension as values change.\n",
-        "sectionCard": [
-          {
-            "name": "Checkout extensions API",
-            "subtitle": "API reference",
-            "url": "/docs/api/checkout-ui-extensions/apis",
-            "type": "blocks"
-          }
-        ],
-        "codeblock": {
-          "title": "Extension.jsx",
-          "tabs": [
-            {
-              "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default async () => {\n  render(<Extension />, document.body);\n};\n\nfunction Extension() {\n  if (\n    shopify.shippingAddress.value?.countryCode !==\n    'CA'\n  ) {\n    return (\n      <s-banner>\n        Sorry, we can only ship to Canada at this\n        time\n      </s-banner>\n    );\n  }\n}\n",
-              "language": "tsx"
-            }
-          ]
-        },
-        "initialLanguage": "tsx"
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "ui-components",
-        "title": "UI components",
-        "sectionContent": "Checkout UI extensions declare their interface using [Polaris web components](/docs/api/checkout-ui-extensions/using-polaris-components). Shopify renders the UI natively, so it’s performant, accessible, and works in all of checkout’s supported browsers.\n\nCheckout components are designed to be flexible, enabling you to layer and mix them to create highly-customized app extensions that feel seamless within the checkout experience. All components inherit a merchant’s brand settings and the CSS cannot be altered or overridden.",
-        "sectionCard": [
-          {
-            "name": "Component library",
-            "subtitle": "API reference",
-            "url": "/docs/api/checkout-ui-extensions/latest/polaris-web-components",
-            "type": "blocks"
-          },
-          {
-            "name": "Figma UI kit",
-            "subtitle": "UI Reference",
-            "url": "https://www.figma.com/community/file/1554582792754361051",
-            "type": "setting"
-          }
-        ],
-        "codeblock": {
-          "title": "Extension.jsx",
-          "tabs": [
-            {
-              "code": "import '@shopify/ui-extensions/preact';\nimport {render} from 'preact';\n\nexport default function extension() {\n  render(<Extension />, document.body);\n}\n\nfunction Extension() {\n  return (\n    <s-stack direction=\"inline\">\n      <s-image src=\"https://cdn.shopify.com/YOUR_IMAGE_HERE\" />\n      <s-stack>\n        <s-heading>Heading</s-heading>\n        <s-text type=\"small\">Description</s-text>\n      </s-stack>\n      <s-button\n        onClick={() => {\n          console.log('button was pressed');\n        }}\n      >\n        Button\n      </s-button>\n    </s-stack>\n  );\n}\n",
-              "language": "tsx"
-            }
-          ]
-        },
-        "initialLanguage": "tsx"
-      },
-      {
-        "type": "Generic",
-        "anchorLink": "security",
-        "title": "Security",
-        "sectionContent": "\nCheckout UI extensions are a safe and secure way to customize the appearance and functionality of the checkout page without compromising the security of checkout or customer data.\n- They run in an isolated sandbox, separate from the checkout page and other UI extensions.\n- They don't have access to sensitive payment information or the checkout page itself (HTML or other assets).\n- They are limited to specific UI components and APIs that are exposed by the platform.\n- They have limited access to [global web APIs](https://github.com/Shopify/ui-extensions/blob/2025-10/documentation/runtime-environment.md).\n- Apps that wish to access [protected customer data](/docs/apps/store/data-protection/protected-customer-data), must submit an application and are subject to strict security guidelines and review proccesses by Shopify.\n",
-        "sectionNotice": [
-          {
-            "title": "Constraints",
-            "sectionContent": "\nYou can’t override the CSS for UI components. The checkout UI will always render the merchant’s own branding.\n\nCheckout UI extensions don’t have access to the real checkout DOM and can’t render arbitrary HTML such as `
` elements or `